LukeParke/api-specs
1
0
Fork 0
mirror of https://github.com/LukeHagar/api-specs.git synced 2025-12-06 12:27:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Apply automatic changes

Browse Source
This commit is contained in:
tyler-mairose-sp
2024-02-23 17:24:01 +00:00
committed by github-actions[bot]
parent 09154c51fa
commit b9787d24cd
5 changed files with 7830 additions and 7319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

268
dereferenced/deref-sailpoint-api.beta.json
View File

@@ -108020,7 +108020,14 @@
"Notifications"
],
"summary": "List Notification Template Defaults",
"description": "This lists the default templates used for notifications, such as emails from IdentityNow. Since this is a beta feature, it doesn't include all the templates.",
"description": "This lists the default templates used for notifications, such as emails from IdentityNow.",
"security": [
{
"UserContextAuth": [
"idn:notification-template-defaults:read"
]
}
],
"parameters": [
{
"in": "query",
@@ -108053,7 +108060,8 @@
"in": "query",
"name": "filters",
"schema": {
"type": "string"
"type": "string",
"example": "key eq \"cloud_manual_work_item_summary\""
},
"description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**key**: *eq, in, sw*\n\n**medium**: *eq, sw*\n\n**locale**: *eq, sw*"
}
@@ -108470,7 +108478,14 @@
"Notifications"
],
"summary": "List Notification Templates",
"description": "This lists the templates that you have modified for your site. Since this is a beta feature, it doesn't include all your modified templates.",
"description": "This lists the templates that you have modified for your site.",
"security": [
{
"UserContextAuth": [
"idn:notification-templates:read"
]
}
],
"parameters": [
{
"in": "query",
@@ -108938,6 +108953,13 @@
],
"summary": "Create Notification Template",
"description": "This creates a template for your site. \n\nYou can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.",
"security": [
{
"UserContextAuth": [
"idn:notification-templates:create"
]
}
],
"requestBody": {
"required": true,
"content": {
@@ -109910,7 +109932,14 @@
"Notifications"
],
"summary": "Bulk Delete Notification Templates",
"description": "This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, you can only delete a subset of your notifications, i.e. ones that show up in the list call.",
"description": "This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage.",
"security": [
{
"UserContextAuth": [
"idn:notification-templates:delete"
]
}
],
"requestBody": {
"required": true,
"content": {
@@ -127977,7 +128006,14 @@
"Notifications"
],
"summary": "Get Notification Template Context",
"description": "The notification service (Hermes) maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes\n that will be available per tenant (organization).\n\nRegarding authorization, the access token contains the tenant and will grant access to the one requested.\nRequires the following security scope: idn:notification-templates:read",
"description": "The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes\n that will be available per tenant (organization).",
"security": [
{
"UserContextAuth": [
"idn:notification-templates:read"
]
}
],
"responses": {
"200": {
"description": "Notification template context attributes for a specific tenant.",
@@ -128349,12 +128385,20 @@
"Notifications"
],
"summary": "Get Notification Preferences for tenant.",
"description": "Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned.\nRequest will require the following legacy roles: ORG_ADMIN and API",
"description": "Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned.",
"security": [
{
"UserContextAuth": [
"idn:notification-preferences:read"
]
}
],
"parameters": [
{
"in": "path",
"name": "key",
"required": true,
"example": "cloud_manual_work_item_summary",
"schema": {
"type": "string"
},
@@ -128718,6 +128762,106 @@
}
}
}
},
"500": {
"description": "Internal Server Error - Returned if there is an unexpected error.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detailCode": {
"type": "string",
"description": "Fine-grained error code providing more detail of the error.",
"example": "400.1 Bad Request Content"
},
"trackingId": {
"type": "string",
"description": "Unique tracking id for the error.",
"example": "e7eab60924f64aa284175b9fa3309599"
},
"messages": {
"type": "array",
"description": "Generic localized reason for error",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "The locale for the message text, a BCP 47 language tag.",
"example": "en-US",
"nullable": true
},
"localeOrigin": {
"type": "string",
"enum": [
"DEFAULT",
"REQUEST",
null
],
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
"example": "DEFAULT",
"nullable": true
},
"text": {
"type": "string",
"description": "Actual text of the error message in the indicated locale.",
"example": "The request was syntactically correct but its content is semantically invalid."
}
}
}
},
"causes": {
"type": "array",
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "The locale for the message text, a BCP 47 language tag.",
"example": "en-US",
"nullable": true
},
"localeOrigin": {
"type": "string",
"enum": [
"DEFAULT",
"REQUEST",
null
],
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
"example": "DEFAULT",
"nullable": true
},
"text": {
"type": "string",
"description": "Actual text of the error message in the indicated locale.",
"example": "The request was syntactically correct but its content is semantically invalid."
}
}
}
}
}
},
"examples": {
"500": {
"summary": "An example of a 500 response object",
"value": {
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}
}
}
}
}
}
}
},
@@ -128726,13 +128870,21 @@
"tags": [
"Notifications"
],
"summary": "Overwrite the preferences for the given notification key.",
"description": "In the notification world, a notification flows through these salient stages - \n 1. Interest matching, \n 2. Preferences \n 3. Template Rendering. \n\nThe default notification preferences make up a part of the second stage, along with user preferences (which is a future goal). The expectation is for admins to be able to set default preferences for their org, like opting in to or out of certain notifications, and configuring future preferences as we tack on more features. The key in the Dto is not necessary but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. \nRequest will require the following legacy roles: ORG_ADMIN and API",
"summary": "Overwrite preferences notification key.",
"description": "Allows admins to opt in to or out of certain notifications for their org. The default state is opted in. `key` is optional but if it is provided and doesn't match the key in the URI, then a 400 will be thrown.",
"security": [
{
"UserContextAuth": [
"idn:notification-preferences:create"
]
}
],
"parameters": [
{
"in": "path",
"name": "key",
"required": true,
"example": "cloud_manual_work_item_summary",
"schema": {
"type": "string"
},
@@ -129137,6 +129289,106 @@
}
}
}
},
"500": {
"description": "Internal Server Error - Returned if there is an unexpected error.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detailCode": {
"type": "string",
"description": "Fine-grained error code providing more detail of the error.",
"example": "400.1 Bad Request Content"
},
"trackingId": {
"type": "string",
"description": "Unique tracking id for the error.",
"example": "e7eab60924f64aa284175b9fa3309599"
},
"messages": {
"type": "array",
"description": "Generic localized reason for error",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "The locale for the message text, a BCP 47 language tag.",
"example": "en-US",
"nullable": true
},
"localeOrigin": {
"type": "string",
"enum": [
"DEFAULT",
"REQUEST",
null
],
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
"example": "DEFAULT",
"nullable": true
},
"text": {
"type": "string",
"description": "Actual text of the error message in the indicated locale.",
"example": "The request was syntactically correct but its content is semantically invalid."
}
}
}
},
"causes": {
"type": "array",
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "The locale for the message text, a BCP 47 language tag.",
"example": "en-US",
"nullable": true
},
"localeOrigin": {
"type": "string",
"enum": [
"DEFAULT",
"REQUEST",
null
],
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
"example": "DEFAULT",
"nullable": true
},
"text": {
"type": "string",
"description": "Actual text of the error message in the indicated locale.",
"example": "The request was syntactically correct but its content is semantically invalid."
}
}
}
}
}
},
"examples": {
"500": {
"summary": "An example of a 500 response object",
"value": {
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}
}
}
}
}
}
}
}

196
dereferenced/deref-sailpoint-api.beta.yaml
View File

@@ -81001,7 +81001,10 @@ paths:
tags:
- Notifications
summary: List Notification Template Defaults
description: 'This lists the default templates used for notifications, such as emails from IdentityNow. Since this is a beta feature, it doesn''t include all the templates.'
description: 'This lists the default templates used for notifications, such as emails from IdentityNow.'
security:
- UserContextAuth:
- 'idn:notification-template-defaults:read'
parameters:
- in: query
name: limit
@@ -81032,6 +81035,7 @@ paths:
name: filters
schema:
type: string
example: key eq "cloud_manual_work_item_summary"
description: |-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
@@ -81345,7 +81349,10 @@ paths:
tags:
- Notifications
summary: List Notification Templates
description: 'This lists the templates that you have modified for your site. Since this is a beta feature, it doesn''t include all your modified templates.'
description: This lists the templates that you have modified for your site.
security:
- UserContextAuth:
- 'idn:notification-templates:read'
parameters:
- in: query
name: limit
@@ -81707,6 +81714,9 @@ paths:
This creates a template for your site.
You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
security:
- UserContextAuth:
- 'idn:notification-templates:create'
requestBody:
required: true
content:
@@ -82429,7 +82439,10 @@ paths:
tags:
- Notifications
summary: Bulk Delete Notification Templates
description: 'This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, you can only delete a subset of your notifications, i.e. ones that show up in the list call.'
description: 'This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage.'
security:
- UserContextAuth:
- 'idn:notification-templates:delete'
requestBody:
required: true
content:
@@ -95791,11 +95804,11 @@ paths:
- Notifications
summary: Get Notification Template Context
description: |-
The notification service (Hermes) maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes
The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes
that will be available per tenant (organization).
Regarding authorization, the access token contains the tenant and will grant access to the one requested.
Requires the following security scope: idn:notification-templates:read
security:
- UserContextAuth:
- 'idn:notification-templates:read'
responses:
'200':
description: Notification template context attributes for a specific tenant.
@@ -96065,13 +96078,15 @@ paths:
tags:
- Notifications
summary: Get Notification Preferences for tenant.
description: |-
Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned.
Request will require the following legacy roles: ORG_ADMIN and API
description: 'Returns the notification preferences for tenant. Note that if the key doesn''t exist, then a 404 will be returned.'
security:
- UserContextAuth:
- 'idn:notification-preferences:read'
parameters:
- in: path
name: key
required: true
example: cloud_manual_work_item_summary
schema:
type: string
description: The notification key.
@@ -96335,23 +96350,93 @@ paths:
message:
description: A message describing the error
example: ' Rate Limit Exceeded '
'500':
description: Internal Server Error - Returned if there is an unexpected error.
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
description: Fine-grained error code providing more detail of the error.
example: 400.1 Bad Request Content
trackingId:
type: string
description: Unique tracking id for the error.
example: e7eab60924f64aa284175b9fa3309599
messages:
type: array
description: Generic localized reason for error
items:
type: object
properties:
locale:
type: string
description: 'The locale for the message text, a BCP 47 language tag.'
example: en-US
nullable: true
localeOrigin:
type: string
enum:
- DEFAULT
- REQUEST
- null
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
example: DEFAULT
nullable: true
text:
type: string
description: Actual text of the error message in the indicated locale.
example: The request was syntactically correct but its content is semantically invalid.
causes:
type: array
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
items:
type: object
properties:
locale:
type: string
description: 'The locale for the message text, a BCP 47 language tag.'
example: en-US
nullable: true
localeOrigin:
type: string
enum:
- DEFAULT
- REQUEST
- null
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
example: DEFAULT
nullable: true
text:
type: string
description: Actual text of the error message in the indicated locale.
example: The request was syntactically correct but its content is semantically invalid.
examples:
'500':
summary: An example of a 500 response object
value:
detailCode: 500.0 Internal Fault
trackingId: b21b1f7ce4da4d639f2c62a57171b427
messages:
- locale: en-US
localeOrigin: DEFAULT
text: An internal fault occurred.
put:
operationId: putNotificationPreference
tags:
- Notifications
summary: Overwrite the preferences for the given notification key.
description: |-
In the notification world, a notification flows through these salient stages -
1. Interest matching,
2. Preferences
3. Template Rendering.
The default notification preferences make up a part of the second stage, along with user preferences (which is a future goal). The expectation is for admins to be able to set default preferences for their org, like opting in to or out of certain notifications, and configuring future preferences as we tack on more features. The key in the Dto is not necessary but if it is provided and doesn't match the key in the URI, then a 400 will be thrown.
Request will require the following legacy roles: ORG_ADMIN and API
summary: Overwrite preferences notification key.
description: 'Allows admins to opt in to or out of certain notifications for their org. The default state is opted in. `key` is optional but if it is provided and doesn''t match the key in the URI, then a 400 will be thrown.'
security:
- UserContextAuth:
- 'idn:notification-preferences:create'
parameters:
- in: path
name: key
required: true
example: cloud_manual_work_item_summary
schema:
type: string
description: The notification key.
@@ -96645,6 +96730,79 @@ paths:
message:
description: A message describing the error
example: ' Rate Limit Exceeded '
'500':
description: Internal Server Error - Returned if there is an unexpected error.
content:
application/json:
schema:
type: object
properties:
detailCode:
type: string
description: Fine-grained error code providing more detail of the error.
example: 400.1 Bad Request Content
trackingId:
type: string
description: Unique tracking id for the error.
example: e7eab60924f64aa284175b9fa3309599
messages:
type: array
description: Generic localized reason for error
items:
type: object
properties:
locale:
type: string
description: 'The locale for the message text, a BCP 47 language tag.'
example: en-US
nullable: true
localeOrigin:
type: string
enum:
- DEFAULT
- REQUEST
- null
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
example: DEFAULT
nullable: true
text:
type: string
description: Actual text of the error message in the indicated locale.
example: The request was syntactically correct but its content is semantically invalid.
causes:
type: array
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
items:
type: object
properties:
locale:
type: string
description: 'The locale for the message text, a BCP 47 language tag.'
example: en-US
nullable: true
localeOrigin:
type: string
enum:
- DEFAULT
- REQUEST
- null
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
example: DEFAULT
nullable: true
text:
type: string
description: Actual text of the error message in the indicated locale.
example: The request was syntactically correct but its content is semantically invalid.
examples:
'500':
summary: An example of a 500 response object
value:
detailCode: 500.0 Internal Fault
trackingId: b21b1f7ce4da4d639f2c62a57171b427
messages:
- locale: en-US
localeOrigin: DEFAULT
text: An internal fault occurred.
/reassignment-configurations/types:
get:
operationId: getReassignmentConfigTypes

8257
postman/collections/sailpoint-api-beta.json
View File

File diff suppressed because one or more lines are too long

1694
postman/collections/sailpoint-api-nerm.json
View File

File diff suppressed because it is too large Load Diff

4734
postman/collections/sailpoint-api-v3.json
View File

File diff suppressed because one or more lines are too long