mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 20:37:49 +00:00
Apply automatic changes
This commit is contained in:
committed by
github-actions[bot]
parent
3586674c6e
commit
a6e271322b
@@ -1027,7 +1027,7 @@ components:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -1102,7 +1102,7 @@ components:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -22666,7 +22666,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -22740,7 +22740,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -23534,7 +23534,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -24008,7 +24008,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -25080,7 +25080,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -25529,7 +25529,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -28631,7 +28631,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -29484,7 +29484,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -30034,7 +30034,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -30909,7 +30909,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -31873,7 +31873,7 @@ paths:
|
||||
deadline:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The campaign's completion deadline.
|
||||
description: 'The campaign''s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.'
|
||||
example: '2020-03-15T10:00:01.456Z'
|
||||
type:
|
||||
type: string
|
||||
@@ -49992,6 +49992,352 @@ paths:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: An internal fault occurred.
|
||||
'/identities/{identityId}/ownership':
|
||||
get:
|
||||
operationId: getIdentityOwnershipDetails
|
||||
summary: Get ownership details
|
||||
tags:
|
||||
- Identities
|
||||
description: Get Ownership association details of an Identity
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- 'idn:identity:read'
|
||||
parameters:
|
||||
- in: path
|
||||
name: identityId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: ff8081814d2a8036014d701f3fbf53fa
|
||||
responses:
|
||||
'200':
|
||||
description: Ownership association details of an Identity.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
associationDetails:
|
||||
type: array
|
||||
description: list of all the resource associations for the identity
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
associationType:
|
||||
type: string
|
||||
description: association type with the identity
|
||||
example: ROLE_OWNER
|
||||
entities:
|
||||
type: array
|
||||
description: the specific resource this identity has ownership on
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
identityEntity:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: id of the resource to which the identity is associated
|
||||
example: 031034e97f094a4096c1be53f75f6b91
|
||||
name:
|
||||
type: string
|
||||
description: name of the resource to which the identity is associated
|
||||
example: Gaston.800ddf9640a
|
||||
type:
|
||||
type: string
|
||||
description: type of the resource to which the identity is associated
|
||||
example: CAMPAIGN_CAMPAIGNER
|
||||
example:
|
||||
id: b660a232f05b4e04812ca974b3011e0f
|
||||
name: Gaston.800ddf9640a
|
||||
type: ROLE
|
||||
example:
|
||||
associationDetails:
|
||||
associationType: ROLE_OWNER
|
||||
entities:
|
||||
- id: b660a232f05b4e04812ca974b3011e0f
|
||||
name: Gaston.800ddf9640a
|
||||
type: ROLE
|
||||
'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.
|
||||
'404':
|
||||
description: Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||
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:
|
||||
'404':
|
||||
summary: An example of a 404 response object
|
||||
value:
|
||||
detailCode: 404 Not found
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: The server did not find a current representation for the target resource.
|
||||
'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.
|
||||
/identities:
|
||||
get:
|
||||
operationId: listIdentities
|
||||
@@ -123952,6 +124298,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -123962,12 +124310,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
@@ -124330,6 +124684,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -124340,12 +124696,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
@@ -124478,6 +124840,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -124488,12 +124852,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
@@ -124838,12 +125208,24 @@ paths:
|
||||
- in: path
|
||||
name: usageType
|
||||
required: true
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
example: CREATE
|
||||
schema:
|
||||
type: string
|
||||
nullable: false
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -124854,14 +125236,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
example: REGISTER
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
responses:
|
||||
'200':
|
||||
description: The requested ProvisioningPolicyDto was successfully retrieved.
|
||||
@@ -124886,6 +125272,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -124896,12 +125284,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
@@ -125245,12 +125639,24 @@ paths:
|
||||
- in: path
|
||||
name: usageType
|
||||
required: true
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
example: CREATE
|
||||
schema:
|
||||
type: string
|
||||
nullable: false
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -125261,13 +125667,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
@@ -125291,6 +125702,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -125301,12 +125714,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
@@ -125371,6 +125790,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -125381,12 +125802,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
@@ -125729,12 +126156,24 @@ paths:
|
||||
- in: path
|
||||
name: usageType
|
||||
required: true
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
example: CREATE
|
||||
schema:
|
||||
type: string
|
||||
nullable: false
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -125745,13 +126184,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
requestBody:
|
||||
required: true
|
||||
description: The JSONPatch payload used to update the schema.
|
||||
@@ -125834,6 +126278,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -125844,12 +126290,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
@@ -126190,12 +126642,24 @@ paths:
|
||||
- in: path
|
||||
name: usageType
|
||||
required: true
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
example: CREATE
|
||||
schema:
|
||||
type: string
|
||||
nullable: false
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -126206,13 +126670,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
responses:
|
||||
'204':
|
||||
description: The ProvisioningPolicyDto was successfully deleted.
|
||||
@@ -126539,6 +127008,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -126549,12 +127020,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
@@ -126621,6 +127098,8 @@ paths:
|
||||
enum:
|
||||
- CREATE
|
||||
- UPDATE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- DELETE
|
||||
- ASSIGN
|
||||
- UNASSIGN
|
||||
@@ -126631,12 +127110,18 @@ paths:
|
||||
- CREATE_IDENTITY
|
||||
- UPDATE_IDENTITY
|
||||
- EDIT_GROUP
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
- UNLOCK
|
||||
- CHANGE_PASSWORD
|
||||
example: CREATE
|
||||
description: The type of ProvisioningPolicy usage.
|
||||
description: |-
|
||||
The type of provisioning policy usage.
|
||||
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
||||
These are the common usage types:
|
||||
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
||||
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
||||
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
||||
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
||||
You can use these four usage types for all your provisioning policy needs.
|
||||
fields:
|
||||
type: array
|
||||
items:
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1 +1 @@
|
||||
https://god.gw.postman.com/run-collection/23226990-b054eb29-6492-462c-8348-099833649073?action=collection%2Ffork&collection-url=entityId%3D23226990-b054eb29-6492-462c-8348-099833649073%26entityType%3Dcollection%26workspaceId%3D80af54be-a333-4712-af5e-41aa9eccbdd0
|
||||
https://god.gw.postman.com/run-collection/23226990-7ae3e9ee-b050-4f55-ad62-129a02216e15?action=collection%2Ffork&collection-url=entityId%3D23226990-7ae3e9ee-b050-4f55-ad62-129a02216e15%26entityType%3Dcollection%26workspaceId%3D80af54be-a333-4712-af5e-41aa9eccbdd0
|
||||
Reference in New Issue
Block a user