mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
Apply automatic changes
This commit is contained in:
tyler-mairose-sp
committed by
github-actions[bot]
github-actions[bot]
parent
be806be59e
commit
f168305179
@@ -43747,7 +43747,7 @@ paths:
|
||||
description: |-
|
||||
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
|
||||
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**.
|
||||
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**.
|
||||
|
||||
When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
||||
|
||||
@@ -43847,6 +43847,18 @@ paths:
|
||||
value:
|
||||
DISPLAY_NAME: true
|
||||
DESCRIPTION: true
|
||||
Add the description for an entitlement:
|
||||
description: This example shows how to use patch to add a description for the entitlement.
|
||||
value:
|
||||
- op: add
|
||||
path: /description
|
||||
value: new description for the entitlement
|
||||
Update the name for an entitlement:
|
||||
description: This example shows how to use patch to update an entitlement's name.
|
||||
value:
|
||||
- op: replace
|
||||
path: /name
|
||||
value: entitlement new name
|
||||
responses:
|
||||
'200':
|
||||
description: Responds with the entitlement as updated.
|
||||
@@ -44326,6 +44338,45 @@ paths:
|
||||
required: true
|
||||
description: Entitlement Id
|
||||
example: 2c91808c74ff913f0175097daa9d59cd
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: |-
|
||||
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
|
||||
example: 'name,-modified'
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
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)
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
**id**: *eq, in*
|
||||
|
||||
**name**: *eq, in, sw*
|
||||
|
||||
**type**: *eq, in*
|
||||
|
||||
**attribute**: *eq, in*
|
||||
|
||||
**value**: *eq, in, sw*
|
||||
|
||||
**source.id**: *eq, in*
|
||||
|
||||
**requestable**: *eq*
|
||||
**created**: *gt, lt, ge, le*
|
||||
**modified**: *gt, lt, ge, le*
|
||||
example: attribute eq "memberOf"
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of entitlements parents from an entitlement
|
||||
@@ -44838,6 +44889,45 @@ paths:
|
||||
required: true
|
||||
description: Entitlement Id
|
||||
example: 2c91808874ff91550175097daaec161c
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: |-
|
||||
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
|
||||
example: 'name,-modified'
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
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)
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
**id**: *eq, in*
|
||||
|
||||
**name**: *eq, in, sw*
|
||||
|
||||
**type**: *eq, in*
|
||||
|
||||
**attribute**: *eq, in*
|
||||
|
||||
**value**: *eq, in, sw*
|
||||
|
||||
**source.id**: *eq, in*
|
||||
|
||||
**requestable**: *eq*
|
||||
**created**: *gt, lt, ge, le*
|
||||
**modified**: *gt, lt, ge, le*
|
||||
example: attribute eq "memberOf"
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of entitlements children from an entitlement
|
||||
@@ -166537,3 +166627,310 @@ paths:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: An internal fault occurred.
|
||||
'/workgroups/{id}':
|
||||
get:
|
||||
operationId: getWorkgroup
|
||||
tags:
|
||||
- Governance Groups
|
||||
summary: Get an Governance Groups
|
||||
description: This API returns an Governance Groups by its ID.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: ID of the Governance Groups
|
||||
example: 2c9180837ca6693d017ca8d097500149
|
||||
responses:
|
||||
'200':
|
||||
description: An Governance Groups
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
owner:
|
||||
description: Owner of the Governance Group
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
description: DTO type
|
||||
type: string
|
||||
enum:
|
||||
- ACCOUNT_CORRELATION_CONFIG
|
||||
- ACCESS_PROFILE
|
||||
- ACCESS_REQUEST_APPROVAL
|
||||
- ACCOUNT
|
||||
- APPLICATION
|
||||
- CAMPAIGN
|
||||
- CAMPAIGN_FILTER
|
||||
- CERTIFICATION
|
||||
- CLUSTER
|
||||
- CONNECTOR_SCHEMA
|
||||
- ENTITLEMENT
|
||||
- GOVERNANCE_GROUP
|
||||
- IDENTITY
|
||||
- IDENTITY_PROFILE
|
||||
- IDENTITY_REQUEST
|
||||
- LIFECYCLE_STATE
|
||||
- PASSWORD_POLICY
|
||||
- ROLE
|
||||
- RULE
|
||||
- SOD_POLICY
|
||||
- SOURCE
|
||||
- TAG
|
||||
- TAG_CATEGORY
|
||||
- TASK_RESULT
|
||||
- REPORT_RESULT
|
||||
- SOD_VIOLATION
|
||||
- ACCOUNT_ACTIVITY
|
||||
example: IDENTITY
|
||||
id:
|
||||
type: string
|
||||
description: ID of the object to which this reference applies
|
||||
example: 2c91808568c529c60168cca6f90c1313
|
||||
name:
|
||||
type: string
|
||||
description: Human-readable name of the owner
|
||||
example: William Wilson
|
||||
displayName:
|
||||
type: string
|
||||
description: Human-readable display name of the owner
|
||||
example: William
|
||||
emailAddress:
|
||||
type: string
|
||||
description: Email ID of the owner
|
||||
example: william@sailpoint.com
|
||||
id:
|
||||
type: string
|
||||
description: ID of the object to which this reference applies
|
||||
example: 2c91808568c529c60168cca6f90c1313
|
||||
description:
|
||||
type: string
|
||||
description: Description of the Governance Group
|
||||
example: Description of the Governance Group
|
||||
memberCount:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 1641498673000
|
||||
description: Number of members in the Governance Group.
|
||||
connectionCount:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 1641498673000
|
||||
description: Number of connections in the Governance Group.
|
||||
'400':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
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
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
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
|
||||
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
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
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
|
||||
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.
|
||||
'401':
|
||||
description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
description: A message describing the error
|
||||
example: 'JWT validation failed: JWT is expired'
|
||||
'403':
|
||||
description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.'
|
||||
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
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
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
|
||||
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
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
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
|
||||
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:
|
||||
'403':
|
||||
summary: An example of a 403 response object
|
||||
value:
|
||||
detailCode: 403 Forbidden
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: The server understood the request but refuses to authorize it.
|
||||
'429':
|
||||
description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
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
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
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
|
||||
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
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
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
|
||||
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.
|
||||
security:
|
||||
- oauth2:
|
||||
- 'idn:workgroup:read'
|
||||
|
||||
Reference in New Issue
Block a user