mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 04:19:19 +00:00
Merge branch 'main' of github.com:sailpoint-oss/api-specs
This commit is contained in:
@@ -28,7 +28,7 @@ delete:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '../schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/LifecyclestateDeleted.yaml'
|
||||||
'401':
|
'401':
|
||||||
$ref: '../../v3/responses/401.yaml'
|
$ref: '../../v3/responses/401.yaml'
|
||||||
'403':
|
'403':
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ post:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/TaskResultDto.yaml'
|
||||||
example:
|
example:
|
||||||
{
|
{
|
||||||
"type": "TASK_RESULT",
|
"type": "TASK_RESULT",
|
||||||
|
|||||||
@@ -35,7 +35,23 @@ get:
|
|||||||
schema:
|
schema:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "../../../v3/schemas/BaseReferenceDto.yaml"
|
type: object
|
||||||
|
description: Identity of workgroup member.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Workgroup member identity DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Workgroup member identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Workgroup member identity display name.
|
||||||
|
example: Michael Michaels
|
||||||
'400':
|
'400':
|
||||||
$ref: '../../../v3/responses/400.yaml'
|
$ref: '../../../v3/responses/400.yaml'
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
17
idn/beta/schemas/AccessItemOwnerDto.yaml
Normal file
17
idn/beta/schemas/AccessItemOwnerDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Access item owner's identity.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's identity ID.
|
||||||
|
example: 2c9180a46faadee4016fb4e018c20639
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's human-readable display name.
|
||||||
|
example: Support
|
||||||
17
idn/beta/schemas/AccessItemRequestedForDto.yaml
Normal file
17
idn/beta/schemas/AccessItemRequestedForDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Identity the access item is requested for.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity the access item is requested for.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity the access item is requested for.
|
||||||
|
example: 2c4180a46faadee4016fb4e018c20626
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable display name of identity the access item is requested for.
|
||||||
|
example: Robert Robinson
|
||||||
17
idn/beta/schemas/AccessItemRequesterDto.yaml
Normal file
17
idn/beta/schemas/AccessItemRequesterDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Access item requester's identity.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Access item requester's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Access item requester's identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20648
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's human-readable display name.
|
||||||
|
example: William Wilson
|
||||||
@@ -16,7 +16,7 @@ properties:
|
|||||||
type:
|
type:
|
||||||
$ref: '../../v3/schemas/RequestableObjectType.yaml'
|
$ref: '../../v3/schemas/RequestableObjectType.yaml'
|
||||||
owner:
|
owner:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './AccessItemOwnerDto.yaml'
|
||||||
requestCommentsRequired:
|
requestCommentsRequired:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: If comments are required while requesting the access item.
|
description: If comments are required while requesting the access item.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
description: A reference to the source of activity
|
description: A reference to the source of activity
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/SourceDto.yaml'
|
||||||
- type: object
|
- type: object
|
||||||
properties:
|
properties:
|
||||||
integrationType:
|
integrationType:
|
||||||
|
|||||||
@@ -14,4 +14,4 @@ properties:
|
|||||||
description: Description of the application.
|
description: Description of the application.
|
||||||
example: Access to research information, lab results, and schematics
|
example: Access to research information, lab results, and schematics
|
||||||
owner:
|
owner:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './AccessItemOwnerDto.yaml'
|
||||||
@@ -6,12 +6,7 @@ required:
|
|||||||
- attributes
|
- attributes
|
||||||
properties:
|
properties:
|
||||||
source:
|
source:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/AttrSyncSource.yaml'
|
||||||
description: Reference to the source which is the target of the attribute synchronization
|
|
||||||
example:
|
|
||||||
- type: 'SOURCE'
|
|
||||||
id: '2c9180835d191a86015d28455b4b232a'
|
|
||||||
name: 'HR Active Directory'
|
|
||||||
attributes:
|
attributes:
|
||||||
type: array
|
type: array
|
||||||
description: Attribute synchronization configuration for specific identity attributes in the context of a source
|
description: Attribute synchronization configuration for specific identity attributes in the context of a source
|
||||||
|
|||||||
@@ -2,12 +2,7 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
source:
|
source:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/AttrSyncSource.yaml'
|
||||||
description: Reference to the source which is the target of the attribute synchronization
|
|
||||||
example:
|
|
||||||
- type: 'SOURCE'
|
|
||||||
id: '2c9180835d191a86015d28455b4b232a'
|
|
||||||
name: 'HR Active Directory'
|
|
||||||
attribute:
|
attribute:
|
||||||
type: string
|
type: string
|
||||||
description: Name of the source account attribute to which the identity attribute values should be synchronized
|
description: Name of the source account attribute to which the identity attribute values should be synchronized
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ properties:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
description: Label to be applied to an Object
|
description: Label to be applied to object.
|
||||||
example: [ "BU_FINANCE", "PCI" ]
|
example: [ "BU_FINANCE", "PCI" ]
|
||||||
operation:
|
operation:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -1,15 +1,9 @@
|
|||||||
description: The previous certification
|
description: Previous certification.
|
||||||
type: object
|
type: object
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/CertificationReferenceDto.yaml'
|
||||||
- type: object
|
- type: object
|
||||||
properties:
|
properties:
|
||||||
reviewer:
|
reviewer:
|
||||||
$ref: './Reviewer.yaml'
|
$ref: './Reviewer.yaml'
|
||||||
description: Certification reviewer
|
description: Certification reviewer
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
description: The type of object that the reviewer is.
|
|
||||||
enum:
|
|
||||||
- "CERTIFICATION"
|
|
||||||
example: CERTIFICATION
|
|
||||||
|
|||||||
@@ -2,3 +2,28 @@ type: object
|
|||||||
properties:
|
properties:
|
||||||
comment:
|
comment:
|
||||||
type: string
|
type: string
|
||||||
|
nullable: true
|
||||||
|
description: Comment content.
|
||||||
|
example: This is a comment.
|
||||||
|
author:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of the commenting identity.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of the commenting identity.
|
||||||
|
example: 2c91808568c529c60168cca6f90c1313
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of the commenting identity.
|
||||||
|
example: Adam Kennedy
|
||||||
|
created:
|
||||||
|
type: string
|
||||||
|
format: 'date-time'
|
||||||
|
description: Date and time comment was created.
|
||||||
|
example: '2017-07-11T18:45:37.098Z'
|
||||||
@@ -27,17 +27,29 @@ properties:
|
|||||||
$ref: '../../v3/schemas/AccessRequestType.yaml'
|
$ref: '../../v3/schemas/AccessRequestType.yaml'
|
||||||
description: If the access-request was for granting or revoking access.
|
description: If the access-request was for granting or revoking access.
|
||||||
requester:
|
requester:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './AccessItemRequesterDto.yaml'
|
||||||
description: The identity that requested the item.
|
|
||||||
requestedFor:
|
requestedFor:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './AccessItemRequestedForDto.yaml'
|
||||||
description: The identity for whom the item is requested for.
|
|
||||||
reviewedBy:
|
reviewedBy:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
type: object
|
||||||
description: The identity who has reviewed the approval.
|
description: Identity who reviewed the access item request.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity who reviewed the access item request.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity who reviewed the access item request.
|
||||||
|
example: 2c3780a46faadee4016fb4e018c20652
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable display name of identity who reviewed the access item request.
|
||||||
|
example: Allen Albertson
|
||||||
owner:
|
owner:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './AccessItemOwnerDto.yaml'
|
||||||
description: The owner or approver of the approval.
|
|
||||||
requestedObject:
|
requestedObject:
|
||||||
$ref: './RequestableObjectReference.yaml'
|
$ref: './RequestableObjectReference.yaml'
|
||||||
description: The requested access item.
|
description: The requested access item.
|
||||||
@@ -45,7 +57,10 @@ properties:
|
|||||||
$ref: '../../v3/schemas/CommentDto.yaml'
|
$ref: '../../v3/schemas/CommentDto.yaml'
|
||||||
description: The requester's comment.
|
description: The requester's comment.
|
||||||
reviewerComment:
|
reviewerComment:
|
||||||
$ref: '../../v3/schemas/CommentDto.yaml'
|
allOf:
|
||||||
|
- $ref: './CommentDto.yaml'
|
||||||
|
type: object
|
||||||
|
nullable: true
|
||||||
description: The approval's reviewer's comment.
|
description: The approval's reviewer's comment.
|
||||||
previousReviewersComments:
|
previousReviewersComments:
|
||||||
type: array
|
type: array
|
||||||
@@ -66,6 +81,7 @@ properties:
|
|||||||
description: The final state of the approval
|
description: The final state of the approval
|
||||||
removeDate:
|
removeDate:
|
||||||
type: string
|
type: string
|
||||||
|
nullable: true
|
||||||
description: The date the role or access profile is no longer assigned to the specified identity.
|
description: The date the role or access profile is no longer assigned to the specified identity.
|
||||||
format: 'date-time'
|
format: 'date-time'
|
||||||
example: '2020-07-11T00:00:00Z'
|
example: '2020-07-11T00:00:00Z'
|
||||||
@@ -75,6 +91,7 @@ properties:
|
|||||||
description: If true, then the request was to change the remove date or sunset date.
|
description: If true, then the request was to change the remove date or sunset date.
|
||||||
currentRemoveDate:
|
currentRemoveDate:
|
||||||
type: string
|
type: string
|
||||||
|
nullable: true
|
||||||
description: The remove date or sunset date that was assigned at the time of the request.
|
description: The remove date or sunset date that was assigned at the time of the request.
|
||||||
format: 'date-time'
|
format: 'date-time'
|
||||||
example: '2020-07-11T00:00:00Z'
|
example: '2020-07-11T00:00:00Z'
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ properties:
|
|||||||
description: Current version of configuration object.
|
description: Current version of configuration object.
|
||||||
example: 1
|
example: 1
|
||||||
self:
|
self:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/SelfImportExportDto.yaml'
|
||||||
object:
|
object:
|
||||||
description: Object details. Format dependant on the object type.
|
description: Object details. Format dependant on the object type.
|
||||||
additionalProperties: true
|
additionalProperties: true
|
||||||
|
|||||||
@@ -21,8 +21,7 @@ properties:
|
|||||||
description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
|
description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
|
||||||
example: "NodeJS Integration"
|
example: "NodeJS Integration"
|
||||||
owner:
|
owner:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/PatOwner.yaml'
|
||||||
description: Details about the owner of the personal access token.
|
|
||||||
created:
|
created:
|
||||||
type: string
|
type: string
|
||||||
format: 'date-time'
|
format: 'date-time'
|
||||||
|
|||||||
@@ -28,9 +28,4 @@ allOf:
|
|||||||
description: Determines if this Entitlement is goverened in the cloud.
|
description: Determines if this Entitlement is goverened in the cloud.
|
||||||
type: boolean
|
type: boolean
|
||||||
source:
|
source:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/EntitlementSource.yaml'
|
||||||
description: Reference to the source this entitlment belongs to.
|
|
||||||
example:
|
|
||||||
- type: 'SOURCE'
|
|
||||||
id: '2c9180835d191a86015d28455b4b232a'
|
|
||||||
name: 'HR Active Directory'
|
|
||||||
17
idn/beta/schemas/EntitlementRef.yaml
Normal file
17
idn/beta/schemas/EntitlementRef.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Entitlement including a specific set of access.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's DTO type.
|
||||||
|
enum:
|
||||||
|
- ENTITLEMENT
|
||||||
|
example: ENTITLEMENT
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's ID.
|
||||||
|
example: 2c91809773dee32014e13e122092014e
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's display name.
|
||||||
|
example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"
|
||||||
@@ -17,8 +17,7 @@ properties:
|
|||||||
description: Scopes of the personal access token.
|
description: Scopes of the personal access token.
|
||||||
example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ]
|
example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ]
|
||||||
owner:
|
owner:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/PatOwner.yaml'
|
||||||
description: Details about the owner of the personal access token.
|
|
||||||
created:
|
created:
|
||||||
type: string
|
type: string
|
||||||
format: 'date-time'
|
format: 'date-time'
|
||||||
|
|||||||
@@ -36,7 +36,23 @@ allOf:
|
|||||||
- LOCKED
|
- LOCKED
|
||||||
example: LOCKED
|
example: LOCKED
|
||||||
managerRef:
|
managerRef:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
type: object
|
||||||
|
description: Identity's manager.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity's manager.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity's manager.
|
||||||
|
example: 2c4180a46faadee4016fb4e018c20626
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable display name of identity's manager.
|
||||||
|
example: Robert Robinson
|
||||||
isManager:
|
isManager:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Whether this identity is a manager of another identity
|
description: Whether this identity is a manager of another identity
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
objectRef:
|
objectRef:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/TaggedObjectDto.yaml'
|
||||||
tags:
|
tags:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
description: Labels to be applied to an Object
|
description: Labels to be applied to object.
|
||||||
example: [ "BU_FINANCE", "PCI" ]
|
example: [ "BU_FINANCE", "PCI" ]
|
||||||
@@ -1,7 +1,23 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
identity:
|
identity:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
type: object
|
||||||
|
description: Identity's manager.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity's manager.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity's manager.
|
||||||
|
example: 2c4180a46faadee4016fb4e018c20626
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable display name of identity's manager.
|
||||||
|
example: Robert Robinson
|
||||||
previewAttributes:
|
previewAttributes:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
|||||||
@@ -6,6 +6,6 @@ properties:
|
|||||||
example: 1
|
example: 1
|
||||||
description: Version or object from the target service.
|
description: Version or object from the target service.
|
||||||
self:
|
self:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/SelfImportExportDto.yaml'
|
||||||
object:
|
object:
|
||||||
$ref: '../../v3/schemas/IdentityProfile.yaml'
|
$ref: '../../v3/schemas/IdentityProfile.yaml'
|
||||||
|
|||||||
@@ -5,13 +5,13 @@ required:
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
identityId:
|
identityId:
|
||||||
description: Set of identity id's to be checked.
|
description: Set of identity IDs to be checked.
|
||||||
type: string
|
type: string
|
||||||
accessRefs:
|
accessRefs:
|
||||||
description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type.
|
description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './EntitlementRef.yaml'
|
||||||
clientMetadata:
|
clientMetadata:
|
||||||
type: object
|
type: object
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
|
|||||||
@@ -38,10 +38,18 @@ properties:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
defaultReferences:
|
defaultReferences:
|
||||||
description: List of BaseRefenceDtos that can be used to resolve references on import.
|
description: List of object types that can be used to resolve references on import.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
type: string
|
||||||
|
enum:
|
||||||
|
- IDENTITY_OBJECT_CONFIG
|
||||||
|
- IDENTITY_PROFILE
|
||||||
|
- RULE
|
||||||
|
- SOURCE
|
||||||
|
- TRANSFORM
|
||||||
|
- TRIGGER_SUBSCRIPTION
|
||||||
|
example: "TRIGGER_SUBSCRIPTION"
|
||||||
excludeBackup:
|
excludeBackup:
|
||||||
description: By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed.
|
description: By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed.
|
||||||
type: boolean
|
type: boolean
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ properties:
|
|||||||
description: References to objects that were created or updated by the import.
|
description: References to objects that were created or updated by the import.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/ImportObject.yaml'
|
||||||
required:
|
required:
|
||||||
- infos
|
- infos
|
||||||
- warnings
|
- warnings
|
||||||
|
|||||||
@@ -27,14 +27,11 @@ properties:
|
|||||||
$ref: '../../v3/schemas/AccessRequestType.yaml'
|
$ref: '../../v3/schemas/AccessRequestType.yaml'
|
||||||
description: If the access-request was for granting or revoking access.
|
description: If the access-request was for granting or revoking access.
|
||||||
requester:
|
requester:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './AccessItemRequesterDto.yaml'
|
||||||
description: The identity that requested the item.
|
|
||||||
requestedFor:
|
requestedFor:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './AccessItemRequestedForDto.yaml'
|
||||||
description: The identity for whom the item is requested for.
|
|
||||||
owner:
|
owner:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './AccessItemOwnerDto.yaml'
|
||||||
description: The owner or approver of the approval.
|
|
||||||
requestedObject:
|
requestedObject:
|
||||||
$ref: './RequestableObjectReference.yaml'
|
$ref: './RequestableObjectReference.yaml'
|
||||||
description: The requested access item.
|
description: The requested access item.
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ properties:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/ServiceDeskSource.yaml'
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
description: The type of object being referenced
|
description: The type of object being referenced
|
||||||
|
|||||||
@@ -1,13 +1,16 @@
|
|||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/SodReportResultDto.yaml'
|
||||||
- type : object
|
- type : object
|
||||||
properties:
|
properties:
|
||||||
status:
|
status:
|
||||||
type: string
|
type: string
|
||||||
enum:
|
description: Status of a SOD policy violation report.
|
||||||
- SUCCESS
|
enum:
|
||||||
- WARNING
|
- SUCCESS
|
||||||
- ERROR
|
- WARNING
|
||||||
- TERMINATED
|
- ERROR
|
||||||
- TEMP_ERROR
|
- TERMINATED
|
||||||
- PENDING
|
- TEMP_ERROR
|
||||||
|
- PENDING
|
||||||
|
example: PENDING
|
||||||
|
|
||||||
@@ -4,17 +4,24 @@ required:
|
|||||||
- type
|
- type
|
||||||
- id
|
- id
|
||||||
- name
|
- name
|
||||||
allOf:
|
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
description: The type of object that the reviewer is.
|
type: string
|
||||||
|
description: The reviewer's DTO type.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
- "GOVERNANCE_GROUP"
|
- GOVERNANCE_GROUP
|
||||||
example: IDENTITY
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: The reviewer's ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: The reviewer's display name.
|
||||||
|
example: Michael Michaels
|
||||||
email:
|
email:
|
||||||
type: string
|
type: string
|
||||||
nullable: true
|
nullable: true
|
||||||
description: 'The email of the reviewing identity. Only applicable to `IDENTITY`'
|
description: The reviewing identity's email. Only applicable to `IDENTITY`.
|
||||||
example: reviewer@test.com
|
example: reviewer@test.com
|
||||||
|
|||||||
@@ -44,13 +44,13 @@ properties:
|
|||||||
UNKNOWN - The integration state is not recognized.
|
UNKNOWN - The integration state is not recognized.
|
||||||
identityNowSource:
|
identityNowSource:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/SourceDto.yaml'
|
||||||
nullable: true
|
nullable: true
|
||||||
description: Reference to mapped IdentityNow Source, if mapping exists.
|
description: Reference to mapped IdentityNow Source, if mapping exists.
|
||||||
example:
|
example:
|
||||||
type: "SOURCE"
|
type: "SOURCE"
|
||||||
id: "2c9180866166b5b0016167c32ef31a66"
|
id: "2c9180835d191a86015d28455b4b232a"
|
||||||
name: "Corporate directory"
|
name: "HR Active Directory"
|
||||||
lastTested:
|
lastTested:
|
||||||
type: string
|
type: string
|
||||||
nullable: true
|
nullable: true
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
allOf:
|
allOf:
|
||||||
- $ref: './BaseCommonDto.yaml'
|
- $ref: './BaseCommonDto.yaml'
|
||||||
- type: object
|
- type: object
|
||||||
description: Specification of a Service Desk integration
|
description: Specification of a Service Desk integration.
|
||||||
required:
|
required:
|
||||||
- description
|
- description
|
||||||
- type
|
- type
|
||||||
- attributes
|
- attributes
|
||||||
properties:
|
properties:
|
||||||
description:
|
description:
|
||||||
description: Description of the Service Desk integration
|
description: Description of the Service Desk integration.
|
||||||
type: string
|
type: string
|
||||||
example: A very nice Service Desk integration
|
example: A very nice Service Desk integration
|
||||||
type:
|
type:
|
||||||
@@ -22,43 +22,17 @@ allOf:
|
|||||||
example: ServiceNowSDIM
|
example: ServiceNowSDIM
|
||||||
ownerRef:
|
ownerRef:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/OwnerDto.yaml'
|
||||||
description: Reference to the identity that is the owner of this Service Desk integration
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
description: The type of object being referenced
|
|
||||||
enum:
|
|
||||||
- IDENTITY
|
|
||||||
example: IDENTITY
|
|
||||||
id:
|
|
||||||
description: ID of the identity
|
|
||||||
example: 2c91808568c529c60168cca6f90c1313
|
|
||||||
name:
|
|
||||||
description: Human-readable display name of the identity
|
|
||||||
example: MyName
|
|
||||||
clusterRef:
|
clusterRef:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/SourceClusterDto.yaml'
|
||||||
description: Reference to the source cluster for this Service Desk integration
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
description: The type of object being referenced
|
|
||||||
enum:
|
|
||||||
- CLUSTER
|
|
||||||
example: CLUSTER
|
|
||||||
id:
|
|
||||||
description: ID of the cluster
|
|
||||||
example: 2c9180866166b5b0016167c32ef31a66
|
|
||||||
name:
|
|
||||||
description: Human-readable display name of the cluster
|
|
||||||
example: Corporate Cluster
|
|
||||||
cluster:
|
cluster:
|
||||||
description: ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)
|
description: ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility).
|
||||||
type: string
|
type: string
|
||||||
example: xyzzy999
|
example: xyzzy999
|
||||||
deprecated: true
|
deprecated: true
|
||||||
managedSources:
|
managedSources:
|
||||||
description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)
|
description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility).
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
@@ -79,17 +53,4 @@ allOf:
|
|||||||
}
|
}
|
||||||
beforeProvisioningRule:
|
beforeProvisioningRule:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/BeforeProvisioningRuleDto.yaml'
|
||||||
description: Reference to beforeProvisioningRule for this Service Desk integration
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
description: The type of object being referenced
|
|
||||||
enum:
|
|
||||||
- RULE
|
|
||||||
example: RULE
|
|
||||||
id:
|
|
||||||
description: ID of the rule
|
|
||||||
example: 2c91808568c529c60168cca6f90c1333
|
|
||||||
name:
|
|
||||||
description: Human-readable display name of the rule
|
|
||||||
example: Example Rule
|
|
||||||
|
|||||||
@@ -2,12 +2,12 @@ type: object
|
|||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: Policy id
|
description: Policy ID.
|
||||||
example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
|
example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
|
||||||
readOnly: true
|
readOnly: true
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
description: Policy Business Name
|
description: Policy business name.
|
||||||
example: "policy-xyz"
|
example: "policy-xyz"
|
||||||
created:
|
created:
|
||||||
type: string
|
type: string
|
||||||
@@ -23,51 +23,51 @@ properties:
|
|||||||
readOnly: true
|
readOnly: true
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
description: Optional description of the SOD policy
|
description: Optional description of the SOD policy.
|
||||||
example: "This policy ensures compliance of xyz"
|
example: "This policy ensures compliance of xyz"
|
||||||
nullable: true
|
nullable: true
|
||||||
ownerRef:
|
ownerRef:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/OwnerDto.yaml'
|
||||||
externalPolicyReference:
|
externalPolicyReference:
|
||||||
type: string
|
type: string
|
||||||
description: Optional External Policy Reference
|
description: Optional external policy reference.
|
||||||
example: "XYZ policy"
|
example: "XYZ policy"
|
||||||
nullable: true
|
nullable: true
|
||||||
policyQuery:
|
policyQuery:
|
||||||
type: string
|
type: string
|
||||||
description: Search query of the SOD policy
|
description: Search query of the SOD policy.
|
||||||
example: "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"
|
example: "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"
|
||||||
compensatingControls:
|
compensatingControls:
|
||||||
type: string
|
type: string
|
||||||
description: Optional compensating controls(Mitigating Controls)
|
description: Optional compensating controls (Mitigating Controls).
|
||||||
example: "Have a manager review the transaction decisions for their \"out of compliance\" employee"
|
example: "Have a manager review the transaction decisions for their \"out of compliance\" employee"
|
||||||
nullable: true
|
nullable: true
|
||||||
correctionAdvice:
|
correctionAdvice:
|
||||||
type: string
|
type: string
|
||||||
description: Optional correction advice
|
description: Optional correction advice.
|
||||||
example: "Based on the role of the employee, managers should remove access that is not required for their job function."
|
example: "Based on the role of the employee, managers should remove access that is not required for their job function."
|
||||||
nullable: true
|
nullable: true
|
||||||
state:
|
state:
|
||||||
type: string
|
type: string
|
||||||
description: whether the policy is enforced or not
|
description: Whether the policy is enforced or not.
|
||||||
enum:
|
enum:
|
||||||
- ENFORCED
|
- ENFORCED
|
||||||
- NOT_ENFORCED
|
- NOT_ENFORCED
|
||||||
example: ENFORCED
|
example: ENFORCED
|
||||||
tags:
|
tags:
|
||||||
type: array
|
type: array
|
||||||
description: tags for this policy object
|
description: Tags for the policy object.
|
||||||
example: ["TAG1", "TAG2"]
|
example: ["TAG1", "TAG2"]
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
creatorId:
|
creatorId:
|
||||||
type: string
|
type: string
|
||||||
description: Policy's creator ID
|
description: Policy's creator ID.
|
||||||
example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
|
example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
|
||||||
readOnly: true
|
readOnly: true
|
||||||
modifierId:
|
modifierId:
|
||||||
type: string
|
type: string
|
||||||
description: Policy's modifier ID
|
description: Policy's modifier ID.
|
||||||
example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
|
example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
|
||||||
nullable : true
|
nullable : true
|
||||||
readOnly: true
|
readOnly: true
|
||||||
@@ -76,12 +76,12 @@ properties:
|
|||||||
nullable: true
|
nullable: true
|
||||||
scheduled:
|
scheduled:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: defines whether a policy has been scheduled or not
|
description: Defines whether a policy has been scheduled or not.
|
||||||
example: true
|
example: true
|
||||||
default: false
|
default: false
|
||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
description: whether a policy is query based or conflicting access based
|
description: Whether a policy is query based or conflicting access based.
|
||||||
default: GENERAL
|
default: GENERAL
|
||||||
enum:
|
enum:
|
||||||
- GENERAL
|
- GENERAL
|
||||||
|
|||||||
17
idn/beta/schemas/SodPolicyDto.yaml
Normal file
17
idn/beta/schemas/SodPolicyDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: SOD policy.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: SOD policy DTO type.
|
||||||
|
enum:
|
||||||
|
- SOD_POLICY
|
||||||
|
example: SOD_POLICY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: SOD policy ID.
|
||||||
|
example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: SOD policy display name.
|
||||||
|
example: Business SOD Policy
|
||||||
@@ -23,7 +23,7 @@ properties:
|
|||||||
recipients:
|
recipients:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/SodRecipient.yaml'
|
||||||
emailEmptyResults:
|
emailEmptyResults:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Indicates if empty results need to be emailed
|
description: Indicates if empty results need to be emailed
|
||||||
|
|||||||
@@ -25,13 +25,8 @@ properties:
|
|||||||
$ref: './SodViolationContext.yaml'
|
$ref: './SodViolationContext.yaml'
|
||||||
violatedPolicies:
|
violatedPolicies:
|
||||||
type: array
|
type: array
|
||||||
description: A list of the Policies that were violated
|
description: A list of the Policies that were violated.
|
||||||
items:
|
items:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: './SodPolicyDto.yaml'
|
||||||
description: Reference to the policy that was violated
|
|
||||||
example:
|
|
||||||
- type: "SOD_POLICY"
|
|
||||||
id: "69129440-422d-4a23-aadd-35c828d5bfda"
|
|
||||||
name: 'HR Policy'
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
description: The contextual information of the violated criteria
|
description: The contextual information of the violated criteria.
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
policy:
|
policy:
|
||||||
$ref: "../../v3/schemas/BaseReferenceDto.yaml"
|
$ref: './SodPolicyDto.yaml'
|
||||||
description: Reference to the Policy that is being violated.
|
|
||||||
conflictingAccessCriteria:
|
conflictingAccessCriteria:
|
||||||
type: object
|
type: object
|
||||||
description: The object which contains the left and right hand side of the entitlements that got violated according to the policy.
|
description: The object which contains the left and right hand side of the entitlements that got violated according to the policy.
|
||||||
|
|||||||
@@ -24,7 +24,30 @@ properties:
|
|||||||
tagCategoryRefs:
|
tagCategoryRefs:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
type: object
|
||||||
|
description: Tagged object's category.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of the tagged object's category.
|
||||||
|
enum:
|
||||||
|
- ACCESS_PROFILE
|
||||||
|
- APPLICATION
|
||||||
|
- CAMPAIGN
|
||||||
|
- ENTITLEMENT
|
||||||
|
- IDENTITY
|
||||||
|
- ROLE
|
||||||
|
- SOD_POLICY
|
||||||
|
- SOURCE
|
||||||
|
example: ENTITLEMENT
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Tagged object's ID.
|
||||||
|
example: 2c91809773dee32014e13e122092014e
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Tagged object's display name.
|
||||||
|
example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"
|
||||||
readOnly: true
|
readOnly: true
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
|
|||||||
20
idn/beta/schemas/TagCategoryDto.yaml
Normal file
20
idn/beta/schemas/TagCategoryDto.yaml
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
type: object
|
||||||
|
description: Tagged object's category.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of the tagged object's category.
|
||||||
|
enum:
|
||||||
|
- ACCESS_PROFILE
|
||||||
|
- ENTITLEMENT
|
||||||
|
- IDENTITIY
|
||||||
|
- ROLE
|
||||||
|
example: ENTITLEMENT
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Tagged object's ID.
|
||||||
|
example: 2c91809773dee32014e13e122092014e
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Tagged object's display name.
|
||||||
|
example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"
|
||||||
@@ -1,8 +1,23 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
manager:
|
manager:
|
||||||
$ref: "../../v3/schemas/BaseReferenceDto.yaml"
|
type: object
|
||||||
description: Reference to the identity's manager
|
description: Manager's identity.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Manager's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Manager's identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Manager's display name.
|
||||||
|
example: Michael Michaels
|
||||||
reports:
|
reports:
|
||||||
$ref: "../schemas/TeamSummaryReportsDto.yaml"
|
$ref: '../schemas/TeamSummaryReportsDto.yaml'
|
||||||
description: Data related to the Identities that are managed by the provided identity
|
description: Data related to the Identities that are managed by the provided identity.
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ properties:
|
|||||||
example: 313c28e5-3c3f-4bfe-bdd6-748afc123576
|
example: 313c28e5-3c3f-4bfe-bdd6-748afc123576
|
||||||
assignments:
|
assignments:
|
||||||
type: array
|
type: array
|
||||||
description: Array of entitlement ids to be assigned to the segment
|
description: Array of entitlement IDs to be assigned to the segment.
|
||||||
items:
|
items:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './EntitlementRef.yaml'
|
||||||
removals:
|
removals:
|
||||||
type: array
|
type: array
|
||||||
description: Array of entitlement ids to be removed from the segment
|
description: Array of entitlement ids to be removed from the segment
|
||||||
items:
|
items:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './EntitlementRef.yaml'
|
||||||
|
|||||||
@@ -16,6 +16,6 @@ properties:
|
|||||||
nullable: true
|
nullable: true
|
||||||
ownerRef:
|
ownerRef:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: '../../v3/schemas/OwnerDto.yaml'
|
||||||
- nullable: true
|
- nullable: true
|
||||||
|
|
||||||
|
|||||||
@@ -8,31 +8,34 @@ allOf:
|
|||||||
executionCount:
|
executionCount:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
description: The number of times this workflow has been executed
|
description: The number of times this workflow has been executed.
|
||||||
example: 2
|
example: 2
|
||||||
failureCount:
|
failureCount:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
description: The number of times this workflow has failed during execution
|
description: The number of times this workflow has failed during execution.
|
||||||
example: 0
|
example: 0
|
||||||
created:
|
created:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
description: The date and time the workflow was created
|
description: The date and time the workflow was created.
|
||||||
example: "2022-01-10T16:06:16.636381447Z"
|
example: "2022-01-10T16:06:16.636381447Z"
|
||||||
creator:
|
creator:
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
description: Workflow creator's identity.
|
||||||
description: The identity that created the workflow.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: Workflow creator's DTO type.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
example: {
|
type: string
|
||||||
"type": "IDENTITY",
|
description: Workflow creator's identity ID.
|
||||||
"id": "2c91808568c529c60168cca6f90c1313",
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
"name": "William Wilson"
|
name:
|
||||||
}
|
type: string
|
||||||
|
description: Workflow creator's display name.
|
||||||
|
example: Michael Michaels
|
||||||
- $ref: './WorkflowBody.yaml'
|
- $ref: './WorkflowBody.yaml'
|
||||||
@@ -17,10 +17,25 @@ properties:
|
|||||||
description: The time when this SOD exception is modified.
|
description: The time when this SOD exception is modified.
|
||||||
example: "2020-01-01T00:00:00.000Z"
|
example: "2020-01-01T00:00:00.000Z"
|
||||||
sodPolicy:
|
sodPolicy:
|
||||||
$ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: './SodPolicyDto.yaml'
|
||||||
example: "00fc6afc-af1d-43af-b350-8d632f4c56ca"
|
|
||||||
identity:
|
identity:
|
||||||
$ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
type: object
|
||||||
|
description: Identity's basic details.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Identity's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Identity's display name.
|
||||||
|
example: Michael Michaels
|
||||||
start:
|
start:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
|
|||||||
13
idn/beta/schemas/sod/models/ExceptionOriginDto.yaml
Normal file
13
idn/beta/schemas/sod/models/ExceptionOriginDto.yaml
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
type: object
|
||||||
|
description: Origin activity of the SOD violation exception.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of origin activity of the SOD violation exception.
|
||||||
|
enum:
|
||||||
|
- ACCOUNT_ACTIVITY
|
||||||
|
example: ACCOUNT_ACTIVITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of role using the access profile.
|
||||||
|
example: 2c9180867372a2590173774358eb016d
|
||||||
@@ -9,18 +9,26 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
example: 2c91808568c529c60168cca6f90c1313
|
example: 2c91808568c529c60168cca6f90c1313
|
||||||
accessRefs:
|
accessRefs:
|
||||||
description: The list of ENTITLEMENTs to consider for calculating possible violations in a preventive check.
|
description: The list of entitlements to consider for possible violations in a preventive check.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Entitlement including a specific set of access.
|
||||||
description: The types of objects supported for SOD violations
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's DTO type.
|
||||||
enum:
|
enum:
|
||||||
- "ENTITLEMENT"
|
- ENTITLEMENT
|
||||||
example: "ENTITLEMENT"
|
example: ENTITLEMENT
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's ID.
|
||||||
|
example: 2c91809773dee32014e13e122092014e
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's display name.
|
||||||
|
example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"
|
||||||
example:
|
example:
|
||||||
- type: ENTITLEMENT
|
- type: ENTITLEMENT
|
||||||
id: 2c918087682f9a86016839c050861ab1
|
id: 2c918087682f9a86016839c050861ab1
|
||||||
|
|||||||
17
idn/beta/schemas/sod/models/SodPolicyDto.yaml
Normal file
17
idn/beta/schemas/sod/models/SodPolicyDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: SOD policy.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: SOD policy DTO type.
|
||||||
|
enum:
|
||||||
|
- SOD_POLICY
|
||||||
|
example: SOD_POLICY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: SOD policy ID.
|
||||||
|
example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: SOD policy display name.
|
||||||
|
example: Business SOD Policy
|
||||||
@@ -2,7 +2,7 @@ type: object
|
|||||||
properties:
|
properties:
|
||||||
policy:
|
policy:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: './SodPolicyDto.yaml'
|
||||||
- type: object
|
- type: object
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
@@ -11,13 +11,13 @@ properties:
|
|||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
example: 'A very cool policy name'
|
example: 'A very cool policy name'
|
||||||
description: The types of objects supported for SOD violations
|
description: The types of objects supported for SOD policy violations.
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
enum:
|
enum:
|
||||||
- "ENTITLEMENT"
|
- "ENTITLEMENT"
|
||||||
example: "ENTITLEMENT"
|
example: "ENTITLEMENT"
|
||||||
description: The type of object that is referenced
|
description: The type of object supported for SOD policy violations.
|
||||||
conflictingAccessCriteria:
|
conflictingAccessCriteria:
|
||||||
$ref: './ExceptionAccessCriteria.yaml'
|
$ref: './ExceptionAccessCriteria.yaml'
|
||||||
nullable: false
|
nullable: false
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Identity who approved the access item request.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity who approved the access item request.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity who approved the access item request.
|
||||||
|
example: 2c3780a46faadee4016fb4e018c20652
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable display name of identity who approved the access item request.
|
||||||
|
example: Allen Albertson
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Identity the access item is requested for.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity the access item is requested for.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity the access item is requested for.
|
||||||
|
example: 2c4180a46faadee4016fb4e018c20626
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable display name of identity the access item is requested for.
|
||||||
|
example: Robert Robinson
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Access item requester's identity.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Access item requester's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Access item requester's identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20648
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's human-readable display name.
|
||||||
|
example: William Wilson
|
||||||
@@ -13,14 +13,7 @@ properties:
|
|||||||
example: 4b4d982dddff4267ab12f0f1e72b5a6d
|
example: 4b4d982dddff4267ab12f0f1e72b5a6d
|
||||||
requestedFor:
|
requestedFor:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: './AccessItemRequestedForDto.yaml'
|
||||||
description: The identity for whom the access is requested for.
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
enum:
|
|
||||||
- "IDENTITY"
|
|
||||||
example: "IDENTITY"
|
|
||||||
description: The type of object that is referenced
|
|
||||||
requestedItems:
|
requestedItems:
|
||||||
description: The access items that are being requested.
|
description: The access items that are being requested.
|
||||||
type: array
|
type: array
|
||||||
@@ -65,11 +58,4 @@ properties:
|
|||||||
example: William needs this access for his day to day job activities.
|
example: William needs this access for his day to day job activities.
|
||||||
requestedBy:
|
requestedBy:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: './AccessItemRequesterDto.yaml'
|
||||||
description: The identity that initiated the access request.
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
enum:
|
|
||||||
- "IDENTITY"
|
|
||||||
example: "IDENTITY"
|
|
||||||
description: The type of object that is referenced
|
|
||||||
@@ -16,14 +16,7 @@ properties:
|
|||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: './AccessItemRequestedForDto.yaml'
|
||||||
description: The identity who the access request is for.
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
enum:
|
|
||||||
- "IDENTITY"
|
|
||||||
example: "IDENTITY"
|
|
||||||
description: The type of object that is referenced
|
|
||||||
requestedItemsStatus:
|
requestedItemsStatus:
|
||||||
description: Details on the outcome of each access item.
|
description: Details on the outcome of each access item.
|
||||||
type: array
|
type: array
|
||||||
@@ -105,7 +98,7 @@ properties:
|
|||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: './AccessItemApproverDto.yaml'
|
||||||
description: The identity of the approver.
|
description: The identity of the approver.
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
@@ -119,11 +112,4 @@ properties:
|
|||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: './AccessItemRequesterDto.yaml'
|
||||||
description: The identity that initiated the access request.
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
enum:
|
|
||||||
- "IDENTITY"
|
|
||||||
example: "IDENTITY"
|
|
||||||
description: The type of object that is referenced
|
|
||||||
@@ -16,14 +16,7 @@ properties:
|
|||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: './AccessItemRequestedForDto.yaml'
|
||||||
description: The identity who the access request is for.
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
enum:
|
|
||||||
- "IDENTITY"
|
|
||||||
example: "IDENTITY"
|
|
||||||
description: The type of object that is referenced
|
|
||||||
requestedItems:
|
requestedItems:
|
||||||
description: Details of the access items being requested.
|
description: Details of the access items being requested.
|
||||||
type: array
|
type: array
|
||||||
@@ -72,11 +65,4 @@ properties:
|
|||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
- $ref: './AccessItemRequesterDto.yaml'
|
||||||
description: The identity that initiated the access request.
|
|
||||||
properties:
|
|
||||||
type:
|
|
||||||
enum:
|
|
||||||
- "IDENTITY"
|
|
||||||
example: "IDENTITY"
|
|
||||||
description: The type of object that is referenced
|
|
||||||
@@ -14,15 +14,23 @@ properties:
|
|||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
- id
|
- id
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: The source the accounts are being aggregated from.
|
||||||
description: The source from which the accounts were aggregated.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: The DTO type of the source the accounts are being aggregated from.
|
||||||
enum:
|
enum:
|
||||||
- SOURCE
|
- SOURCE
|
||||||
description: The type of object that is referenced
|
|
||||||
example: SOURCE
|
example: SOURCE
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: The ID of the source the accounts are being aggregated from.
|
||||||
|
example: 2c9180835d191a86015d28455b4b232a
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of the source the accounts are being aggregated from.
|
||||||
|
example: HR Active Directory
|
||||||
status:
|
status:
|
||||||
description: The overall status of the aggregation.
|
description: The overall status of the aggregation.
|
||||||
enum:
|
enum:
|
||||||
|
|||||||
@@ -11,15 +11,23 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: The identity whose account attributes were updated.
|
||||||
description: The identity whose account attributes changed.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of the identity whose account attributes were updated.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of the identity whose account attributes were updated.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of the identity whose account attributes were updated.
|
||||||
|
example: Michael Michaels
|
||||||
source:
|
source:
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
|
|||||||
@@ -11,52 +11,68 @@ properties:
|
|||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
- id
|
- id
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Identity the account is correlated with.
|
||||||
description: The identity that the account correlated with.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of the identity the account is correlated with.
|
||||||
enum:
|
enum:
|
||||||
- IDENTITY
|
- IDENTITY
|
||||||
description: The type of object that is referenced
|
|
||||||
example: IDENTITY
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of the identity the account is correlated with.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of the identity the account is correlated with.
|
||||||
|
example: Michael Michaels
|
||||||
source:
|
source:
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
type: object
|
type: object
|
||||||
description: The source from which the account came from.
|
description: The source the accounts are being correlated from.
|
||||||
properties:
|
properties:
|
||||||
id:
|
|
||||||
description: ID of the object to which this reference applies
|
|
||||||
type: string
|
|
||||||
example: 4e4d982dddff4267ab12f0f1e72b5a6d
|
|
||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
|
description: The DTO type of the source the accounts are being correlated from.
|
||||||
enum:
|
enum:
|
||||||
- SOURCE
|
- SOURCE
|
||||||
example: SOURCE
|
example: SOURCE
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: The ID of the source the accounts are being correlated from.
|
||||||
|
example: 2c9180835d191a86015d28455b4b232a
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
description: Human-readable display name of the object to which this reference applies
|
description: Display name of the source the accounts are being correlated from.
|
||||||
example: Corporate Active Directory
|
example: HR Active Directory
|
||||||
account:
|
account:
|
||||||
|
type: object
|
||||||
|
description: The correlated account.
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- name
|
- name
|
||||||
- nativeIdentity
|
- nativeIdentity
|
||||||
- type
|
- type
|
||||||
allOf:
|
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
|
||||||
description: The account that was correlated.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: The correlated account's DTO type.
|
||||||
enum:
|
enum:
|
||||||
- ACCOUNT
|
- ACCOUNT
|
||||||
description: The type of object that is referenced
|
|
||||||
example: ACCOUNT
|
example: ACCOUNT
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: The correlated account's ID.
|
||||||
|
example: 98da47c31df444558c211f9b205184f6
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: The correlated account's display name.
|
||||||
|
example: Brian Mendoza
|
||||||
nativeIdentity:
|
nativeIdentity:
|
||||||
type: string
|
type: string
|
||||||
description: Unique ID of the account on the source.
|
description: Unique ID of the account on the source.
|
||||||
|
|||||||
@@ -10,44 +10,67 @@ properties:
|
|||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
- id
|
- id
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Identity the account is uncorrelated with.
|
||||||
description: The identity that the account uncorrelated with.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of the identity the account is uncorrelated with.
|
||||||
enum:
|
enum:
|
||||||
- IDENTITY
|
- IDENTITY
|
||||||
description: The type of object that is referenced
|
|
||||||
example: IDENTITY
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of the identity the account is uncorrelated with.
|
||||||
|
example: 2c3780a46faadee4016fb4e018c20652
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of the identity the account is uncorrelated with.
|
||||||
|
example: Allen Albertson
|
||||||
source:
|
source:
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
- id
|
- id
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: The source the accounts are uncorrelated from.
|
||||||
description: The source from which the account came from.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: The DTO type of the source the accounts are uncorrelated from.
|
||||||
enum:
|
enum:
|
||||||
- SOURCE
|
- SOURCE
|
||||||
description: The type of object that is referenced
|
|
||||||
example: SOURCE
|
example: SOURCE
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: The ID of the source the accounts are uncorrelated from.
|
||||||
|
example: 2c6180835d191a86015d28455b4b231b
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of the source the accounts are uncorrelated from.
|
||||||
|
example: Corporate Directory
|
||||||
account:
|
account:
|
||||||
|
type: object
|
||||||
|
description: Uncorrelated account.
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- name
|
- name
|
||||||
- nativeIdentity
|
- nativeIdentity
|
||||||
- type
|
- type
|
||||||
allOf:
|
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
|
||||||
description: The account that was uncorrelated.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
enum:
|
enum:
|
||||||
- ACCOUNT
|
- ACCOUNT
|
||||||
description: The type of object that is referenced
|
description: Uncorrelated account's DTO type.
|
||||||
example: ACCOUNT
|
example: ACCOUNT
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Uncorrelated account's ID.
|
||||||
|
example: 4dd497e3723e439991cb6d0e478375dd
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Uncorrelated account's display name.
|
||||||
|
example: Sadie Jensen
|
||||||
nativeIdentity:
|
nativeIdentity:
|
||||||
type: string
|
type: string
|
||||||
description: Unique ID of the account on the source.
|
description: Unique ID of the account on the source.
|
||||||
|
|||||||
@@ -9,15 +9,23 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Identity whose attributes changed.
|
||||||
description: The identity who's attributes changed.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity whose attributes changed.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity whose attributes changed.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of identity whose attributes changed.
|
||||||
|
example: Michael Michaels
|
||||||
changes:
|
changes:
|
||||||
description: A list of one or more identity attributes that changed on the identity.
|
description: A list of one or more identity attributes that changed on the identity.
|
||||||
type: array
|
type: array
|
||||||
|
|||||||
@@ -9,18 +9,26 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Created identity.
|
||||||
description: The identity that was created.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: Created identity's DTO type.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: Created identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Created identity's display name.
|
||||||
|
example: Michael Michaels
|
||||||
attributes:
|
attributes:
|
||||||
type: object
|
type: object
|
||||||
description: The attributes assigned to the identity. Attributes are determined by the identity profile.
|
description: The attributes assigned to the identity. Attributes are determined by the identity profile.
|
||||||
additionalProperties: true
|
additionalProperties: true
|
||||||
example: {
|
example: {
|
||||||
"firstname": "John"
|
"firstname": "John"
|
||||||
|
|||||||
@@ -9,18 +9,26 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Deleted identity.
|
||||||
description: The identity that was deleted.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: Deleted identity's DTO type.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: Deleted identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Deleted identity's display name.
|
||||||
|
example: Michael Michaels
|
||||||
attributes:
|
attributes:
|
||||||
type: object
|
type: object
|
||||||
description: The attributes assigned to the identity. Attributes are determined by the identity profile.
|
description: The attributes assigned to the identity. Attributes are determined by the identity profile.
|
||||||
additionalProperties: true
|
additionalProperties: true
|
||||||
example: {
|
example: {
|
||||||
"firstname": "John"
|
"firstname": "John"
|
||||||
|
|||||||
@@ -38,30 +38,46 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Provisioning recpient.
|
||||||
description: Reference to the identity who is the target of the provisioning request.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: Provisioning recipient DTO type.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: Provisioning recipient's identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Provisioning recipient's display name.
|
||||||
|
example: Michael Michaels
|
||||||
requester:
|
requester:
|
||||||
nullable: true
|
nullable: true
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Provisioning requester's identity.
|
||||||
description: Reference to the identity (if any) who submitted the provisioning request.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: Provisioning requester's DTO type.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: Provisioning requester's identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20648
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Provisioning owner's human-readable display name.
|
||||||
|
example: William Wilson
|
||||||
accountRequests:
|
accountRequests:
|
||||||
type: array
|
type: array
|
||||||
description: A list of provisioning instructions to perform on an account-by-account basis.
|
description: A list of provisioning instructions to perform on an account-by-account basis.
|
||||||
|
|||||||
@@ -34,12 +34,20 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- name
|
- name
|
||||||
- type
|
- type
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Identity who created the source.
|
||||||
description: The identity that created the source.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity who created the source.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity who created the source.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20648
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of identity who created the source.
|
||||||
|
example: William Wilson
|
||||||
@@ -34,12 +34,20 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- name
|
- name
|
||||||
- type
|
- type
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Identity who deleted the source.
|
||||||
description: The identity that deleted the source.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity who deleted the source.
|
||||||
enum:
|
enum:
|
||||||
- "IDENTITY"
|
- IDENTITY
|
||||||
example: "IDENTITY"
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity who deleted the source.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20648
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of identity who deleted the source.
|
||||||
|
example: William Wilson
|
||||||
@@ -33,12 +33,20 @@ properties:
|
|||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
- name
|
- name
|
||||||
allOf:
|
type: object
|
||||||
- $ref: '../../../../v3/schemas/BaseReferenceDto.yaml'
|
description: Identity who updated the source.
|
||||||
description: The identity or system that performed the update.
|
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity who updated the source.
|
||||||
enum:
|
enum:
|
||||||
- IDENTITY
|
- IDENTITY
|
||||||
example: IDENTITY
|
example: IDENTITY
|
||||||
description: The type of object that is referenced
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity who updated the source.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20648
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of identity who updated the source.
|
||||||
|
example: William Wilson
|
||||||
@@ -1,7 +1,23 @@
|
|||||||
description: List of identities to be added or removed to a Governance Group members list.
|
description: List of identities to be added or removed to a Governance Group members list.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "../../../v3/schemas/BaseReferenceDto.yaml"
|
type: object
|
||||||
|
description: Identity's basic details.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Identity's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Identity's display name.
|
||||||
|
example: Michael Michaels
|
||||||
example:
|
example:
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,30 +1,30 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
owner:
|
owner:
|
||||||
$ref: "../../../v3/schemas/BaseReferenceDto.yaml"
|
$ref: '../../../v3/schemas/OwnerDto.yaml'
|
||||||
description: Owner of the Governance Group
|
description: Governance group owner.
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: ID of the object to which this reference applies
|
description: Governance group ID.
|
||||||
example: 2c91808568c529c60168cca6f90c1313
|
example: 2c91808568c529c60168cca6f90c1313
|
||||||
readOnly: true
|
readOnly: true
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
description: Name of the Governance Group
|
description: Governance group name.
|
||||||
example: DB Access Governance Group
|
example: DB Access Governance Group
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
description: Description of the Governance Group
|
description: Governance group description.
|
||||||
example: Description of the Governance Group
|
example: Description of the Governance Group
|
||||||
memberCount:
|
memberCount:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
example: 1641498673000
|
example: 1641498673000
|
||||||
readOnly: true
|
readOnly: true
|
||||||
description: Number of members in the Governance Group.
|
description: Number of members in the governance group.
|
||||||
connectionCount:
|
connectionCount:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
example: 1641498673000
|
example: 1641498673000
|
||||||
description: Number of connections in the Governance Group.
|
description: Number of connections in the governance group.
|
||||||
readOnly: true
|
readOnly: true
|
||||||
17
idn/v3/EntitlementRef.yaml
Normal file
17
idn/v3/EntitlementRef.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Entitlement including a specific set of access.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's DTO type.
|
||||||
|
enum:
|
||||||
|
- ENTITLEMENT
|
||||||
|
example: ENTITLEMENT
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's ID.
|
||||||
|
example: 2c91809773dee32014e13e122092014e
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's display name.
|
||||||
|
example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"
|
||||||
@@ -137,7 +137,7 @@ delete:
|
|||||||
- Lifecycle States
|
- Lifecycle States
|
||||||
summary: Delete Lifecycle State by ID
|
summary: Delete Lifecycle State by ID
|
||||||
description: >-
|
description: >-
|
||||||
This endpoint deletes the Lifecycle State using it's ID.
|
This endpoint deletes the Lifecycle State using its ID.
|
||||||
|
|
||||||
A token with API, or ORG_ADMIN authority is required to call this API.
|
A token with API, or ORG_ADMIN authority is required to call this API.
|
||||||
security:
|
security:
|
||||||
@@ -163,7 +163,7 @@ delete:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '../schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/LifecyclestateDeleted.yaml'
|
||||||
'400':
|
'400':
|
||||||
$ref: '../responses/400.yaml'
|
$ref: '../responses/400.yaml'
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ post:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/TaskResultDto.yaml'
|
||||||
example:
|
example:
|
||||||
{
|
{
|
||||||
"type": "TASK_RESULT",
|
"type": "TASK_RESULT",
|
||||||
|
|||||||
17
idn/v3/schemas/AccessItemRequestedFor.yaml
Normal file
17
idn/v3/schemas/AccessItemRequestedFor.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Identity the access item is requested for.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity the access item is requested for.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity the access item is requested for.
|
||||||
|
example: 2c4180a46faadee4016fb4e018c20626
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable display name of identity the access item is requested for.
|
||||||
|
example: Robert Robinson
|
||||||
17
idn/v3/schemas/AccessItemRequester.yaml
Normal file
17
idn/v3/schemas/AccessItemRequester.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Access item requester's identity.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Access item requester's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Access item requester's identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20648
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's human-readable display name.
|
||||||
|
example: William Wilson
|
||||||
17
idn/v3/schemas/AccessItemReviewedBy.yaml
Normal file
17
idn/v3/schemas/AccessItemReviewedBy.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Identity who reviewed the access item request.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of identity who reviewed the access item request.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of identity who reviewed the access item request.
|
||||||
|
example: 2c3780a46faadee4016fb4e018c20652
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable display name of identity who reviewed the access item request.
|
||||||
|
example: Allen Albertson
|
||||||
@@ -6,17 +6,26 @@ properties:
|
|||||||
True if the request for this item was forwarded from one owner to another.
|
True if the request for this item was forwarded from one owner to another.
|
||||||
example: false
|
example: false
|
||||||
originalOwner:
|
originalOwner:
|
||||||
$ref: "./BaseReferenceDto.yaml"
|
type: object
|
||||||
description: >-
|
description: Identity of orginal approval owner.
|
||||||
Base identity/workgroup reference object representing the original owner,
|
properties:
|
||||||
if forwarded.
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of original approval owner's identity.
|
||||||
|
enum:
|
||||||
|
- GOVERNANCE_GROUP
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of original approval owner's identity.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of original approval owner.
|
||||||
|
example: Michael Michaels
|
||||||
currentOwner:
|
currentOwner:
|
||||||
$ref: "./BaseReferenceDto.yaml"
|
$ref: './AccessItemReviewedBy.yaml'
|
||||||
description: >-
|
|
||||||
Base reference of approver that will make decision.
|
|
||||||
reviewedBy:
|
|
||||||
$ref: "./BaseReferenceDto.yaml"
|
|
||||||
description: The identity who has reviewed the approval.
|
|
||||||
modified:
|
modified:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
|
|||||||
17
idn/v3/schemas/AttrSyncSource.yaml
Normal file
17
idn/v3/schemas/AttrSyncSource.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Target source for attribute synchronization.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of target source for attribute synchronization.
|
||||||
|
enum:
|
||||||
|
- SOURCE
|
||||||
|
example: SOURCE
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of target source for attribute synchronization.
|
||||||
|
example: 2c9180835d191a86015d28455b4b232a
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable name of target source for attribute synchronization.
|
||||||
|
example: HR Active Directory
|
||||||
17
idn/v3/schemas/BeforeProvisioningRuleDto.yaml
Normal file
17
idn/v3/schemas/BeforeProvisioningRuleDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Before Provisioning Rule.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Before Provisioning Rule DTO type.
|
||||||
|
enum:
|
||||||
|
- RULE
|
||||||
|
example: RULE
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Before Provisioning Rule ID.
|
||||||
|
example: 048eb3d55c5a4758bd07dccb87741c78
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Rule display name.
|
||||||
|
example: Before Provisioning Airtable Rule
|
||||||
@@ -3,12 +3,12 @@ properties:
|
|||||||
comment:
|
comment:
|
||||||
type: string
|
type: string
|
||||||
description: Comment made by the owner when cancelling the associated request.
|
description: Comment made by the owner when cancelling the associated request.
|
||||||
example: Nisl quis ipsum quam quisque condimentum nunc ut dolor nunc.
|
example: This request must be cancelled.
|
||||||
owner:
|
owner:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/OwnerDto.yaml'
|
||||||
modified:
|
modified:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
description: Date comment was added by the owner when cancelling the associated request
|
description: Date comment was added by the owner when cancelling the associated request.
|
||||||
example: '2019-12-20T09:17:12.192Z'
|
example: '2019-12-20T09:17:12.192Z'
|
||||||
description: Provides additional details for a request that has been cancelled.
|
description: Provides additional details for a request that has been cancelled.
|
||||||
17
idn/v3/schemas/CertificationReferenceDto.yaml
Normal file
17
idn/v3/schemas/CertificationReferenceDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Certification for review.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of certification for review.
|
||||||
|
enum:
|
||||||
|
- CERTIFICATION
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of certification for review.
|
||||||
|
example: 7589a83cec4b4f138ce56c1a5ef0756d
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of certification for review.
|
||||||
|
example: Manager Access for Michael Michaels
|
||||||
@@ -2,23 +2,28 @@ type: object
|
|||||||
properties:
|
properties:
|
||||||
comment:
|
comment:
|
||||||
type: string
|
type: string
|
||||||
description: Content of the comment
|
nullable: true
|
||||||
example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
|
description: Comment content.
|
||||||
|
example: This is a comment.
|
||||||
author:
|
author:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
$ref: './DtoType.yaml'
|
type: string
|
||||||
|
description: DTO type of the commenting identity.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: ID of the author
|
description: ID of the commenting identity.
|
||||||
example: 2c91808568c529c60168cca6f90c1313
|
example: 2c91808568c529c60168cca6f90c1313
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
description: Human-readable display name of the identity making the comment
|
description: Display name of the commenting identity.
|
||||||
example: Adam Kennedy
|
example: Adam Kennedy
|
||||||
created:
|
created:
|
||||||
type: string
|
type: string
|
||||||
format: 'date-time'
|
format: 'date-time'
|
||||||
description: Date and time comment was created
|
description: Date and time comment was created.
|
||||||
example: '2017-07-11T18:45:37.098Z'
|
example: '2017-07-11T18:45:37.098Z'
|
||||||
@@ -27,17 +27,13 @@ properties:
|
|||||||
$ref: './AccessRequestType.yaml'
|
$ref: './AccessRequestType.yaml'
|
||||||
description: If the access-request was for granting or revoking access.
|
description: If the access-request was for granting or revoking access.
|
||||||
requester:
|
requester:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: './AccessItemRequester.yaml'
|
||||||
description: The identity that requested the item.
|
|
||||||
requestedFor:
|
requestedFor:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: './AccessItemRequestedFor.yaml'
|
||||||
description: The identity for whom the item is requested for.
|
|
||||||
reviewedBy:
|
reviewedBy:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: './AccessItemReviewedBy.yaml'
|
||||||
description: The identity who has reviewed the approval.
|
|
||||||
owner:
|
owner:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: './OwnerDto.yaml'
|
||||||
description: The owner or approver of the approval.
|
|
||||||
requestedObject:
|
requestedObject:
|
||||||
$ref: './RequestableObjectReference.yaml'
|
$ref: './RequestableObjectReference.yaml'
|
||||||
description: The requested access item.
|
description: The requested access item.
|
||||||
|
|||||||
@@ -21,8 +21,7 @@ properties:
|
|||||||
description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
|
description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
|
||||||
example: "NodeJS Integration"
|
example: "NodeJS Integration"
|
||||||
owner:
|
owner:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/PatOwner.yaml'
|
||||||
description: Details about the owner of the personal access token.
|
|
||||||
created:
|
created:
|
||||||
type: string
|
type: string
|
||||||
format: 'date-time'
|
format: 'date-time'
|
||||||
|
|||||||
18
idn/v3/schemas/CurrentWorkItemOwnerDto.yaml
Normal file
18
idn/v3/schemas/CurrentWorkItemOwnerDto.yaml
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
type: object
|
||||||
|
description: Identity of current work item owner.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of current work item owner's identity.
|
||||||
|
enum:
|
||||||
|
- GOVERNANCE_GROUP
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of current work item owner's identity.
|
||||||
|
example: 2c3780a46faadee4016fb4e018c20652
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of current work item owner.
|
||||||
|
example: Allen Albertson
|
||||||
@@ -37,9 +37,4 @@ allOf:
|
|||||||
type: boolean
|
type: boolean
|
||||||
example: false
|
example: false
|
||||||
source:
|
source:
|
||||||
$ref: "./BaseReferenceDto.yaml"
|
$ref: '../../v3/schemas/EntitlementSource.yaml'
|
||||||
description: Reference to the source this entitlment belongs to.
|
|
||||||
example:
|
|
||||||
- type: "SOURCE"
|
|
||||||
id: "2c9180835d191a86015d28455b4b232a"
|
|
||||||
name: "HR Active Directory"
|
|
||||||
|
|||||||
17
idn/v3/schemas/EntitlementRef.yaml
Normal file
17
idn/v3/schemas/EntitlementRef.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Entitlement including a specific set of access.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's DTO type.
|
||||||
|
enum:
|
||||||
|
- ENTITLEMENT
|
||||||
|
example: ENTITLEMENT
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's ID.
|
||||||
|
example: 2c91809773dee32014e13e122092014e
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Entitlement's display name.
|
||||||
|
example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"
|
||||||
17
idn/v3/schemas/EntitlementSource.yaml
Normal file
17
idn/v3/schemas/EntitlementSource.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Source the entitlement belongs to.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of source the entitlement belongs to.
|
||||||
|
enum:
|
||||||
|
- SOURCE
|
||||||
|
example: SOURCE
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of source the entitlement belongs to.
|
||||||
|
example: 2c9180835d191a86015d28455b4b232a
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Human-readable name of source the entitlement belongs to.
|
||||||
|
example: HR Active Directory
|
||||||
@@ -17,8 +17,7 @@ properties:
|
|||||||
description: Scopes of the personal access token.
|
description: Scopes of the personal access token.
|
||||||
example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ]
|
example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ]
|
||||||
owner:
|
owner:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/PatOwner.yaml'
|
||||||
description: Details about the owner of the personal access token.
|
|
||||||
created:
|
created:
|
||||||
type: string
|
type: string
|
||||||
format: 'date-time'
|
format: 'date-time'
|
||||||
|
|||||||
@@ -1,7 +1,23 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
identity:
|
identity:
|
||||||
$ref: '../schemas/BaseReferenceDto.yaml'
|
type: object
|
||||||
|
description: Identity's basic details.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Identity's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Identity ID.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Identity's display name.
|
||||||
|
example: Michael Michaels
|
||||||
previewAttributes:
|
previewAttributes:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
type: object
|
type: object
|
||||||
description: Identity Profile exported object
|
description: Identity profile exported object.
|
||||||
properties:
|
properties:
|
||||||
version:
|
version:
|
||||||
type: integer
|
type: integer
|
||||||
@@ -7,6 +7,45 @@ properties:
|
|||||||
description: Version or object from the target service.
|
description: Version or object from the target service.
|
||||||
format: 'int32'
|
format: 'int32'
|
||||||
self:
|
self:
|
||||||
$ref: '../schemas/BaseReferenceDto.yaml'
|
type: object
|
||||||
|
description: Self block for exported object.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Exported object's DTO type.
|
||||||
|
enum:
|
||||||
|
- ACCESS_PROFILE
|
||||||
|
- ACCESS_REQUEST_CONFIG
|
||||||
|
- ATTR_SYNC_SOURCE_CONFIG
|
||||||
|
- AUTH_ORG
|
||||||
|
- CAMPAIGN_FILTER
|
||||||
|
- FORM_DEFINITION
|
||||||
|
- GOVERNANCE_GROUP
|
||||||
|
- IDENTITY_OBJECT_CONFIG
|
||||||
|
- IDENTITY_PROFILE
|
||||||
|
- LIFECYCLE_STATE
|
||||||
|
- NOTIFICATION_TEMPLATE
|
||||||
|
- PASSWORD_POLICY
|
||||||
|
- PASSWORD_SYNC_GROUP
|
||||||
|
- PUBLIC_IDENTITIES_CONFIG
|
||||||
|
- ROLE
|
||||||
|
- RULE
|
||||||
|
- SEGMENT
|
||||||
|
- SERVICE_DESK_INTEGRATION
|
||||||
|
- SOD_POLICY
|
||||||
|
- SOURCE
|
||||||
|
- TAG
|
||||||
|
- TRANSFORM
|
||||||
|
- TRIGGER_SUBSCRIPTION
|
||||||
|
- WORKFLOW
|
||||||
|
example: SOURCE
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Exported object's ID.
|
||||||
|
example: 2c9180835d191a86015d28455b4b232a
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Exported object's display name.
|
||||||
|
example: HR Active Directory
|
||||||
object:
|
object:
|
||||||
$ref: '../schemas/IdentityProfile.yaml'
|
$ref: '../schemas/IdentityProfile.yaml'
|
||||||
|
|||||||
17
idn/v3/schemas/IdentityUpdatedAccountAttributesDto.yaml
Normal file
17
idn/v3/schemas/IdentityUpdatedAccountAttributesDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: The identity whose account attributes were updated.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of the identity whose account attributes were updated.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of the identity whose account attributes were updated.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of the identity whose account attributes were updated.
|
||||||
|
example: Michael Michaels
|
||||||
@@ -5,14 +5,15 @@ required:
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
identityId:
|
identityId:
|
||||||
description: Set of identity id's to be checked.
|
description: Set of identity IDs to be checked.
|
||||||
type: string
|
type: string
|
||||||
example: '2c91809050db617d0150e0bf3215385e'
|
example: '2c91809050db617d0150e0bf3215385e'
|
||||||
accessRefs:
|
accessRefs:
|
||||||
description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type.
|
description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
allOf:
|
||||||
|
- $ref: './EntitlementRef.yaml'
|
||||||
clientMetadata:
|
clientMetadata:
|
||||||
type: object
|
type: object
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
|
|||||||
22
idn/v3/schemas/ImportObject.yaml
Normal file
22
idn/v3/schemas/ImportObject.yaml
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
type: object
|
||||||
|
description: Object created or updated by import.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of object created or updated by import.
|
||||||
|
enum:
|
||||||
|
- IDENTITY_OBJECT_CONFIG
|
||||||
|
- IDENTITY_PROFILE
|
||||||
|
- RULE
|
||||||
|
- SOURCE
|
||||||
|
- TRANSFORM
|
||||||
|
- TRIGGER_SUBSCRIPTION
|
||||||
|
example: SOURCE
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of object created or updated by import.
|
||||||
|
example: 2c9180835d191a86015d28455b4b232a
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of object created or updated by import.
|
||||||
|
example: HR Active Directory
|
||||||
17
idn/v3/schemas/LifecyclestateDeleted.yaml
Normal file
17
idn/v3/schemas/LifecyclestateDeleted.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Deleted lifecycle state.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Deleted lifecycle state's DTO type.
|
||||||
|
enum:
|
||||||
|
- LIFECYCLE_STATE
|
||||||
|
example: LIFECYCLE_STATE
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Deleted lifecycle state ID.
|
||||||
|
example: 12345
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Deleted lifecycle state's display name.
|
||||||
|
example: Contractor Lifecycle
|
||||||
@@ -5,13 +5,43 @@ properties:
|
|||||||
description: True if the request for this item was forwarded from one owner to another.
|
description: True if the request for this item was forwarded from one owner to another.
|
||||||
example: true
|
example: true
|
||||||
originalOwner:
|
originalOwner:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
type: object
|
||||||
description: >-
|
description: Identity of original work item owner, if the work item has been forwarded.
|
||||||
Base identity/workgroup reference object representing the original owner, if forwarded.
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of original work item owner's identity.
|
||||||
|
enum:
|
||||||
|
- GOVERNANCE_GROUP
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of original work item owner's identity.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of original work item owner.
|
||||||
|
example: Michael Michaels
|
||||||
currentOwner:
|
currentOwner:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
type: object
|
||||||
description: >-
|
description: Identity of current work item owner.
|
||||||
Base reference of approver that will make decision.
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of current work item owner's identity.
|
||||||
|
enum:
|
||||||
|
- GOVERNANCE_GROUP
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of current work item owner's identity.
|
||||||
|
example: 2c3780a46faadee4016fb4e018c20652
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of current work item owner.
|
||||||
|
example: Allen Albertson
|
||||||
modified:
|
modified:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ properties:
|
|||||||
description: References to objects that were created or updated by the import.
|
description: References to objects that were created or updated by the import.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '../schemas/BaseReferenceDto.yaml'
|
$ref: '../../v3/schemas/ImportObject.yaml'
|
||||||
required:
|
required:
|
||||||
- infos
|
- infos
|
||||||
- warnings
|
- warnings
|
||||||
|
|||||||
18
idn/v3/schemas/OriginalApprovalOwnerDto.yaml
Normal file
18
idn/v3/schemas/OriginalApprovalOwnerDto.yaml
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
type: object
|
||||||
|
description: Identity of orginal approval owner.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of original approval owner's identity.
|
||||||
|
enum:
|
||||||
|
- GOVERNANCE_GROUP
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of original approval owner's identity.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of original approval owner.
|
||||||
|
example: Michael Michaels
|
||||||
18
idn/v3/schemas/OriginalWorkItemOwnerDto.yaml
Normal file
18
idn/v3/schemas/OriginalWorkItemOwnerDto.yaml
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
type: object
|
||||||
|
description: Identity of original work item owner.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: DTO type of original work item owner's identity.
|
||||||
|
enum:
|
||||||
|
- GOVERNANCE_GROUP
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: ID of original work item owner's identity.
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Display name of original work item owner.
|
||||||
|
example: Michael Michaels
|
||||||
17
idn/v3/schemas/OwnerDto.yaml
Normal file
17
idn/v3/schemas/OwnerDto.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Owner's identity.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Owner's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Owner's identity ID.
|
||||||
|
example: 2c9180a46faadee4016fb4e018c20639
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Owner's display name.
|
||||||
|
example: Support
|
||||||
17
idn/v3/schemas/PatOwner.yaml
Normal file
17
idn/v3/schemas/PatOwner.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
type: object
|
||||||
|
description: Personal access token owner's identity.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Personal access token owner's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Personal access token owner's identity ID.
|
||||||
|
example: 2c9180a46faadee4016fb4e018c20639
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Personal access token owner's human-readable display name.
|
||||||
|
example: Support
|
||||||
@@ -27,14 +27,27 @@ properties:
|
|||||||
$ref: './AccessRequestType.yaml'
|
$ref: './AccessRequestType.yaml'
|
||||||
description: If the access-request was for granting or revoking access.
|
description: If the access-request was for granting or revoking access.
|
||||||
requester:
|
requester:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: './AccessItemRequester.yaml'
|
||||||
description: The identity that requested the item.
|
|
||||||
requestedFor:
|
requestedFor:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
$ref: './AccessItemRequestedFor.yaml'
|
||||||
description: The identity for whom the item is requested for.
|
|
||||||
owner:
|
owner:
|
||||||
$ref: './BaseReferenceDto.yaml'
|
type: object
|
||||||
description: The owner or approver of the approval.
|
description: Access item owner's identity.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's DTO type.
|
||||||
|
enum:
|
||||||
|
- IDENTITY
|
||||||
|
example: IDENTITY
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's identity ID.
|
||||||
|
example: 2c9180a46faadee4016fb4e018c20639
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: Access item owner's human-readable display name.
|
||||||
|
example: Support
|
||||||
requestedObject:
|
requestedObject:
|
||||||
$ref: './RequestableObjectReference.yaml'
|
$ref: './RequestableObjectReference.yaml'
|
||||||
description: The requested access item.
|
description: The requested access item.
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user