diff --git a/idn/beta/paths/delete-lifecycle-state.yaml b/idn/beta/paths/delete-lifecycle-state.yaml index 640cafb..82ab335 100644 --- a/idn/beta/paths/delete-lifecycle-state.yaml +++ b/idn/beta/paths/delete-lifecycle-state.yaml @@ -28,7 +28,7 @@ delete: content: application/json: schema: - $ref: '../schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/LifecyclestateDeleted.yaml' '401': $ref: '../../v3/responses/401.yaml' '403': diff --git a/idn/beta/paths/role-bulk-delete.yaml b/idn/beta/paths/role-bulk-delete.yaml index 11ae34e..8aa487b 100644 --- a/idn/beta/paths/role-bulk-delete.yaml +++ b/idn/beta/paths/role-bulk-delete.yaml @@ -26,7 +26,7 @@ post: content: application/json: schema: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/TaskResultDto.yaml' example: { "type": "TASK_RESULT", diff --git a/idn/beta/paths/workgroups/workgroup-members.yaml b/idn/beta/paths/workgroups/workgroup-members.yaml index 1d1918e..54bb5df 100644 --- a/idn/beta/paths/workgroups/workgroup-members.yaml +++ b/idn/beta/paths/workgroups/workgroup-members.yaml @@ -35,7 +35,23 @@ get: schema: type: array 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': $ref: '../../../v3/responses/400.yaml' '401': diff --git a/idn/beta/schemas/AccessItemOwnerDto.yaml b/idn/beta/schemas/AccessItemOwnerDto.yaml new file mode 100644 index 0000000..8c03bab --- /dev/null +++ b/idn/beta/schemas/AccessItemOwnerDto.yaml @@ -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 diff --git a/idn/beta/schemas/AccessItemRequestedForDto.yaml b/idn/beta/schemas/AccessItemRequestedForDto.yaml new file mode 100644 index 0000000..45bcb3c --- /dev/null +++ b/idn/beta/schemas/AccessItemRequestedForDto.yaml @@ -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 diff --git a/idn/beta/schemas/AccessItemRequesterDto.yaml b/idn/beta/schemas/AccessItemRequesterDto.yaml new file mode 100644 index 0000000..1f13b8b --- /dev/null +++ b/idn/beta/schemas/AccessItemRequesterDto.yaml @@ -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 diff --git a/idn/beta/schemas/AccessReference.yaml b/idn/beta/schemas/AccessReference.yaml index 88da5e7..4083916 100644 --- a/idn/beta/schemas/AccessReference.yaml +++ b/idn/beta/schemas/AccessReference.yaml @@ -16,7 +16,7 @@ properties: type: $ref: '../../v3/schemas/RequestableObjectType.yaml' owner: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: './AccessItemOwnerDto.yaml' requestCommentsRequired: type: boolean description: If comments are required while requesting the access item. diff --git a/idn/beta/schemas/ActivityDataSource.yaml b/idn/beta/schemas/ActivityDataSource.yaml index 1703218..2d6c0c7 100644 --- a/idn/beta/schemas/ActivityDataSource.yaml +++ b/idn/beta/schemas/ActivityDataSource.yaml @@ -1,6 +1,6 @@ description: A reference to the source of activity allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + - $ref: '../../v3/schemas/SourceDto.yaml' - type: object properties: integrationType: diff --git a/idn/beta/schemas/ApplicationReference.yaml b/idn/beta/schemas/ApplicationReference.yaml index ec4eced..2e0e511 100644 --- a/idn/beta/schemas/ApplicationReference.yaml +++ b/idn/beta/schemas/ApplicationReference.yaml @@ -14,4 +14,4 @@ properties: description: Description of the application. example: Access to research information, lab results, and schematics owner: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' \ No newline at end of file + $ref: './AccessItemOwnerDto.yaml' \ No newline at end of file diff --git a/idn/beta/schemas/AttrSyncSourceConfig.yaml b/idn/beta/schemas/AttrSyncSourceConfig.yaml index fafc83e..ef9b651 100644 --- a/idn/beta/schemas/AttrSyncSourceConfig.yaml +++ b/idn/beta/schemas/AttrSyncSourceConfig.yaml @@ -6,12 +6,7 @@ required: - attributes properties: source: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: Reference to the source which is the target of the attribute synchronization - example: - - type: 'SOURCE' - id: '2c9180835d191a86015d28455b4b232a' - name: 'HR Active Directory' + $ref: '../../v3/schemas/AttrSyncSource.yaml' attributes: type: array description: Attribute synchronization configuration for specific identity attributes in the context of a source diff --git a/idn/beta/schemas/AttrSyncTenantSyncTarget.yaml b/idn/beta/schemas/AttrSyncTenantSyncTarget.yaml index 6bdb70a..0d2a1e1 100644 --- a/idn/beta/schemas/AttrSyncTenantSyncTarget.yaml +++ b/idn/beta/schemas/AttrSyncTenantSyncTarget.yaml @@ -2,12 +2,7 @@ type: object properties: source: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: Reference to the source which is the target of the attribute synchronization - example: - - type: 'SOURCE' - id: '2c9180835d191a86015d28455b4b232a' - name: 'HR Active Directory' + $ref: '../../v3/schemas/AttrSyncSource.yaml' attribute: type: string description: Name of the source account attribute to which the identity attribute values should be synchronized diff --git a/idn/beta/schemas/BulkTaggedObject.yaml b/idn/beta/schemas/BulkTaggedObject.yaml index fb89174..3ebbb34 100644 --- a/idn/beta/schemas/BulkTaggedObject.yaml +++ b/idn/beta/schemas/BulkTaggedObject.yaml @@ -8,7 +8,7 @@ properties: type: array items: type: string - description: Label to be applied to an Object + description: Label to be applied to object. example: [ "BU_FINANCE", "PCI" ] operation: type: string diff --git a/idn/beta/schemas/CertificationReference.yaml b/idn/beta/schemas/CertificationReference.yaml index 10f1fd8..c490094 100644 --- a/idn/beta/schemas/CertificationReference.yaml +++ b/idn/beta/schemas/CertificationReference.yaml @@ -1,15 +1,9 @@ -description: The previous certification +description: Previous certification. type: object allOf: -- $ref: '../../v3/schemas/BaseReferenceDto.yaml' +- $ref: '../../v3/schemas/CertificationReferenceDto.yaml' - type: object properties: reviewer: $ref: './Reviewer.yaml' description: Certification reviewer -properties: - type: - description: The type of object that the reviewer is. - enum: - - "CERTIFICATION" - example: CERTIFICATION diff --git a/idn/beta/schemas/CommentDto.yaml b/idn/beta/schemas/CommentDto.yaml index 1ecdce7..026c52d 100644 --- a/idn/beta/schemas/CommentDto.yaml +++ b/idn/beta/schemas/CommentDto.yaml @@ -1,4 +1,29 @@ type: object properties: comment: - type: string \ No newline at end of file + 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' \ No newline at end of file diff --git a/idn/beta/schemas/CompletedApproval.yaml b/idn/beta/schemas/CompletedApproval.yaml index c038f87..421dd31 100644 --- a/idn/beta/schemas/CompletedApproval.yaml +++ b/idn/beta/schemas/CompletedApproval.yaml @@ -27,17 +27,29 @@ properties: $ref: '../../v3/schemas/AccessRequestType.yaml' description: If the access-request was for granting or revoking access. requester: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that requested the item. + $ref: './AccessItemRequesterDto.yaml' requestedFor: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: The identity for whom the item is requested for. + $ref: './AccessItemRequestedForDto.yaml' reviewedBy: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: The identity who has reviewed the approval. + 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 owner: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: The owner or approver of the approval. + $ref: './AccessItemOwnerDto.yaml' requestedObject: $ref: './RequestableObjectReference.yaml' description: The requested access item. @@ -45,7 +57,10 @@ properties: $ref: '../../v3/schemas/CommentDto.yaml' description: The requester's comment. reviewerComment: - $ref: '../../v3/schemas/CommentDto.yaml' + allOf: + - $ref: './CommentDto.yaml' + type: object + nullable: true description: The approval's reviewer's comment. previousReviewersComments: type: array @@ -66,6 +81,7 @@ properties: description: The final state of the approval removeDate: type: string + nullable: true description: The date the role or access profile is no longer assigned to the specified identity. format: 'date-time' 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. currentRemoveDate: type: string + nullable: true description: The remove date or sunset date that was assigned at the time of the request. format: 'date-time' example: '2020-07-11T00:00:00Z' diff --git a/idn/beta/schemas/ConfigObject.yaml b/idn/beta/schemas/ConfigObject.yaml index 8bb42d4..d607a75 100644 --- a/idn/beta/schemas/ConfigObject.yaml +++ b/idn/beta/schemas/ConfigObject.yaml @@ -7,7 +7,7 @@ properties: description: Current version of configuration object. example: 1 self: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/SelfImportExportDto.yaml' object: description: Object details. Format dependant on the object type. additionalProperties: true diff --git a/idn/beta/schemas/CreatePersonalAccessTokenResponse.yaml b/idn/beta/schemas/CreatePersonalAccessTokenResponse.yaml index 2f437b8..8bdc412 100644 --- a/idn/beta/schemas/CreatePersonalAccessTokenResponse.yaml +++ b/idn/beta/schemas/CreatePersonalAccessTokenResponse.yaml @@ -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. example: "NodeJS Integration" owner: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: Details about the owner of the personal access token. + $ref: '../../v3/schemas/PatOwner.yaml' created: type: string format: 'date-time' diff --git a/idn/beta/schemas/EntitlementDto.yaml b/idn/beta/schemas/EntitlementDto.yaml index 51a996a..ac98fd2 100644 --- a/idn/beta/schemas/EntitlementDto.yaml +++ b/idn/beta/schemas/EntitlementDto.yaml @@ -28,9 +28,4 @@ allOf: description: Determines if this Entitlement is goverened in the cloud. type: boolean source: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: Reference to the source this entitlment belongs to. - example: - - type: 'SOURCE' - id: '2c9180835d191a86015d28455b4b232a' - name: 'HR Active Directory' \ No newline at end of file + $ref: '../../v3/schemas/EntitlementSource.yaml' \ No newline at end of file diff --git a/idn/beta/schemas/EntitlementRef.yaml b/idn/beta/schemas/EntitlementRef.yaml new file mode 100644 index 0000000..53e2cc2 --- /dev/null +++ b/idn/beta/schemas/EntitlementRef.yaml @@ -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" \ No newline at end of file diff --git a/idn/beta/schemas/GetPersonalAccessTokenResponse.yaml b/idn/beta/schemas/GetPersonalAccessTokenResponse.yaml index f5fdf8a..5c75203 100644 --- a/idn/beta/schemas/GetPersonalAccessTokenResponse.yaml +++ b/idn/beta/schemas/GetPersonalAccessTokenResponse.yaml @@ -17,8 +17,7 @@ properties: description: Scopes of the personal access token. example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ] owner: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: Details about the owner of the personal access token. + $ref: '../../v3/schemas/PatOwner.yaml' created: type: string format: 'date-time' diff --git a/idn/beta/schemas/Identity.yaml b/idn/beta/schemas/Identity.yaml index 2b0b2a0..0ff1257 100644 --- a/idn/beta/schemas/Identity.yaml +++ b/idn/beta/schemas/Identity.yaml @@ -36,7 +36,23 @@ allOf: - LOCKED example: LOCKED 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: type: boolean description: Whether this identity is a manager of another identity diff --git a/idn/beta/schemas/IdentityEntitlements.yaml b/idn/beta/schemas/IdentityEntitlements.yaml index 57a6086..29969f6 100644 --- a/idn/beta/schemas/IdentityEntitlements.yaml +++ b/idn/beta/schemas/IdentityEntitlements.yaml @@ -1,10 +1,10 @@ type: object properties: objectRef: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/TaggedObjectDto.yaml' tags: type: array items: type: string - description: Labels to be applied to an Object + description: Labels to be applied to object. example: [ "BU_FINANCE", "PCI" ] \ No newline at end of file diff --git a/idn/beta/schemas/IdentityPreviewResponse.yaml b/idn/beta/schemas/IdentityPreviewResponse.yaml index 37ece7e..cc97e2a 100644 --- a/idn/beta/schemas/IdentityPreviewResponse.yaml +++ b/idn/beta/schemas/IdentityPreviewResponse.yaml @@ -1,7 +1,23 @@ type: object properties: 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: type: array items: diff --git a/idn/beta/schemas/IdentityProfileExportedObject.yaml b/idn/beta/schemas/IdentityProfileExportedObject.yaml index d7b35c4..774ac93 100644 --- a/idn/beta/schemas/IdentityProfileExportedObject.yaml +++ b/idn/beta/schemas/IdentityProfileExportedObject.yaml @@ -6,6 +6,6 @@ properties: example: 1 description: Version or object from the target service. self: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/SelfImportExportDto.yaml' object: $ref: '../../v3/schemas/IdentityProfile.yaml' diff --git a/idn/beta/schemas/IdentityWithNewAccess.yaml b/idn/beta/schemas/IdentityWithNewAccess.yaml index b5ed349..0246d30 100644 --- a/idn/beta/schemas/IdentityWithNewAccess.yaml +++ b/idn/beta/schemas/IdentityWithNewAccess.yaml @@ -5,13 +5,13 @@ required: type: object properties: identityId: - description: Set of identity id's to be checked. + description: Set of identity IDs to be checked. type: string accessRefs: description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. type: array items: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: './EntitlementRef.yaml' clientMetadata: type: object additionalProperties: diff --git a/idn/beta/schemas/ImportOptions.yaml b/idn/beta/schemas/ImportOptions.yaml index e3257f8..a508e25 100644 --- a/idn/beta/schemas/ImportOptions.yaml +++ b/idn/beta/schemas/ImportOptions.yaml @@ -38,10 +38,18 @@ properties: } } 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 items: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + type: string + enum: + - IDENTITY_OBJECT_CONFIG + - IDENTITY_PROFILE + - RULE + - SOURCE + - TRANSFORM + - TRIGGER_SUBSCRIPTION + example: "TRIGGER_SUBSCRIPTION" 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. type: boolean diff --git a/idn/beta/schemas/ObjectImportResult.yaml b/idn/beta/schemas/ObjectImportResult.yaml index ebdfa67..f7fd53c 100644 --- a/idn/beta/schemas/ObjectImportResult.yaml +++ b/idn/beta/schemas/ObjectImportResult.yaml @@ -21,7 +21,7 @@ properties: description: References to objects that were created or updated by the import. type: array items: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/ImportObject.yaml' required: - infos - warnings diff --git a/idn/beta/schemas/PendingApproval.yaml b/idn/beta/schemas/PendingApproval.yaml index 6ab7873..aa3ab93 100644 --- a/idn/beta/schemas/PendingApproval.yaml +++ b/idn/beta/schemas/PendingApproval.yaml @@ -27,14 +27,11 @@ properties: $ref: '../../v3/schemas/AccessRequestType.yaml' description: If the access-request was for granting or revoking access. requester: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that requested the item. + $ref: './AccessItemRequesterDto.yaml' requestedFor: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: The identity for whom the item is requested for. + $ref: './AccessItemRequestedForDto.yaml' owner: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: The owner or approver of the approval. + $ref: './AccessItemOwnerDto.yaml' requestedObject: $ref: './RequestableObjectReference.yaml' description: The requested access item. diff --git a/idn/beta/schemas/ProvisioningConfig.yaml b/idn/beta/schemas/ProvisioningConfig.yaml index fc3a64f..2dbd37a 100644 --- a/idn/beta/schemas/ProvisioningConfig.yaml +++ b/idn/beta/schemas/ProvisioningConfig.yaml @@ -11,7 +11,7 @@ properties: type: array items: allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + - $ref: '../../v3/schemas/ServiceDeskSource.yaml' properties: type: description: The type of object being referenced diff --git a/idn/beta/schemas/ReportResultReference.yaml b/idn/beta/schemas/ReportResultReference.yaml index 63db361..0d96958 100644 --- a/idn/beta/schemas/ReportResultReference.yaml +++ b/idn/beta/schemas/ReportResultReference.yaml @@ -1,13 +1,16 @@ allOf: -- $ref: '../../v3/schemas/BaseReferenceDto.yaml' -- type : object - properties: - status: - type: string - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING \ No newline at end of file + - $ref: '../../v3/schemas/SodReportResultDto.yaml' + - type : object + properties: + status: + type: string + description: Status of a SOD policy violation report. + enum: + - SUCCESS + - WARNING + - ERROR + - TERMINATED + - TEMP_ERROR + - PENDING + example: PENDING + \ No newline at end of file diff --git a/idn/beta/schemas/Reviewer.yaml b/idn/beta/schemas/Reviewer.yaml index f968077..f3b7f9b 100644 --- a/idn/beta/schemas/Reviewer.yaml +++ b/idn/beta/schemas/Reviewer.yaml @@ -4,17 +4,24 @@ required: - type - id - name -allOf: -- $ref: '../../v3/schemas/BaseReferenceDto.yaml' properties: type: - description: The type of object that the reviewer is. + type: string + description: The reviewer's DTO type. enum: - - "IDENTITY" - - "GOVERNANCE_GROUP" + - IDENTITY + - GOVERNANCE_GROUP 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: type: string 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 diff --git a/idn/beta/schemas/SaasManagementApplication.yaml b/idn/beta/schemas/SaasManagementApplication.yaml index 34411c3..bdaaf3b 100644 --- a/idn/beta/schemas/SaasManagementApplication.yaml +++ b/idn/beta/schemas/SaasManagementApplication.yaml @@ -44,13 +44,13 @@ properties: UNKNOWN - The integration state is not recognized. identityNowSource: allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + - $ref: '../../v3/schemas/SourceDto.yaml' nullable: true description: Reference to mapped IdentityNow Source, if mapping exists. example: type: "SOURCE" - id: "2c9180866166b5b0016167c32ef31a66" - name: "Corporate directory" + id: "2c9180835d191a86015d28455b4b232a" + name: "HR Active Directory" lastTested: type: string nullable: true diff --git a/idn/beta/schemas/ServiceDeskIntegrationDto.yaml b/idn/beta/schemas/ServiceDeskIntegrationDto.yaml index 22a8fb1..ecf7bb9 100644 --- a/idn/beta/schemas/ServiceDeskIntegrationDto.yaml +++ b/idn/beta/schemas/ServiceDeskIntegrationDto.yaml @@ -1,14 +1,14 @@ allOf: - $ref: './BaseCommonDto.yaml' - type: object - description: Specification of a Service Desk integration + description: Specification of a Service Desk integration. required: - description - type - attributes properties: description: - description: Description of the Service Desk integration + description: Description of the Service Desk integration. type: string example: A very nice Service Desk integration type: @@ -22,43 +22,17 @@ allOf: example: ServiceNowSDIM ownerRef: allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.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 + - $ref: '../../v3/schemas/OwnerDto.yaml' clusterRef: allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.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 + - $ref: '../../v3/schemas/SourceClusterDto.yaml' 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 example: xyzzy999 deprecated: true 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 items: type: string @@ -79,17 +53,4 @@ allOf: } beforeProvisioningRule: allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.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 + - $ref: '../../v3/schemas/BeforeProvisioningRuleDto.yaml' diff --git a/idn/beta/schemas/SodPolicy.yaml b/idn/beta/schemas/SodPolicy.yaml index 79c9c8d..152e061 100644 --- a/idn/beta/schemas/SodPolicy.yaml +++ b/idn/beta/schemas/SodPolicy.yaml @@ -2,12 +2,12 @@ type: object properties: id: type: string - description: Policy id + description: Policy ID. example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" readOnly: true name: type: string - description: Policy Business Name + description: Policy business name. example: "policy-xyz" created: type: string @@ -23,51 +23,51 @@ properties: readOnly: true description: type: string - description: Optional description of the SOD policy + description: Optional description of the SOD policy. example: "This policy ensures compliance of xyz" nullable: true ownerRef: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/OwnerDto.yaml' externalPolicyReference: type: string - description: Optional External Policy Reference + description: Optional external policy reference. example: "XYZ policy" nullable: true policyQuery: 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)" compensatingControls: 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" nullable: true correctionAdvice: 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." nullable: true state: type: string - description: whether the policy is enforced or not + description: Whether the policy is enforced or not. enum: - ENFORCED - NOT_ENFORCED example: ENFORCED tags: type: array - description: tags for this policy object + description: Tags for the policy object. example: ["TAG1", "TAG2"] items: type: string creatorId: type: string - description: Policy's creator ID + description: Policy's creator ID. example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" readOnly: true modifierId: type: string - description: Policy's modifier ID + description: Policy's modifier ID. example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" nullable : true readOnly: true @@ -76,12 +76,12 @@ properties: nullable: true scheduled: type: boolean - description: defines whether a policy has been scheduled or not + description: Defines whether a policy has been scheduled or not. example: true default: false type: 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 enum: - GENERAL diff --git a/idn/beta/schemas/SodPolicyDto.yaml b/idn/beta/schemas/SodPolicyDto.yaml new file mode 100644 index 0000000..fc5b06a --- /dev/null +++ b/idn/beta/schemas/SodPolicyDto.yaml @@ -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 diff --git a/idn/beta/schemas/SodPolicySchedule.yaml b/idn/beta/schemas/SodPolicySchedule.yaml index 06a517b..a5ecbbc 100644 --- a/idn/beta/schemas/SodPolicySchedule.yaml +++ b/idn/beta/schemas/SodPolicySchedule.yaml @@ -23,7 +23,7 @@ properties: recipients: type: array items: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/SodRecipient.yaml' emailEmptyResults: type: boolean description: Indicates if empty results need to be emailed diff --git a/idn/beta/schemas/SodViolationCheckResult.yaml b/idn/beta/schemas/SodViolationCheckResult.yaml index 5d711dc..f11f63d 100644 --- a/idn/beta/schemas/SodViolationCheckResult.yaml +++ b/idn/beta/schemas/SodViolationCheckResult.yaml @@ -25,13 +25,8 @@ properties: $ref: './SodViolationContext.yaml' violatedPolicies: type: array - description: A list of the Policies that were violated + description: A list of the Policies that were violated. items: - $ref: './BaseReferenceDto.yaml' - description: Reference to the policy that was violated - example: - - type: "SOD_POLICY" - id: "69129440-422d-4a23-aadd-35c828d5bfda" - name: 'HR Policy' + $ref: './SodPolicyDto.yaml' diff --git a/idn/beta/schemas/SodViolationContext.yaml b/idn/beta/schemas/SodViolationContext.yaml index 4fef577..bafcd9c 100644 --- a/idn/beta/schemas/SodViolationContext.yaml +++ b/idn/beta/schemas/SodViolationContext.yaml @@ -1,9 +1,8 @@ -description: The contextual information of the violated criteria +description: The contextual information of the violated criteria. type: object properties: policy: - $ref: "../../v3/schemas/BaseReferenceDto.yaml" - description: Reference to the Policy that is being violated. + $ref: './SodPolicyDto.yaml' conflictingAccessCriteria: type: object description: The object which contains the left and right hand side of the entitlements that got violated according to the policy. diff --git a/idn/beta/schemas/Tag.yaml b/idn/beta/schemas/Tag.yaml index e661875..cab254e 100644 --- a/idn/beta/schemas/Tag.yaml +++ b/idn/beta/schemas/Tag.yaml @@ -23,8 +23,31 @@ properties: readOnly: true tagCategoryRefs: type: array - items: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + items: + 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 required: - id diff --git a/idn/beta/schemas/TagCategoryDto.yaml b/idn/beta/schemas/TagCategoryDto.yaml new file mode 100644 index 0000000..c7c831e --- /dev/null +++ b/idn/beta/schemas/TagCategoryDto.yaml @@ -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" diff --git a/idn/beta/schemas/TeamSummaryDto.yaml b/idn/beta/schemas/TeamSummaryDto.yaml index eaaca34..533fd61 100644 --- a/idn/beta/schemas/TeamSummaryDto.yaml +++ b/idn/beta/schemas/TeamSummaryDto.yaml @@ -1,8 +1,23 @@ type: object properties: manager: - $ref: "../../v3/schemas/BaseReferenceDto.yaml" - description: Reference to the identity's manager + type: object + 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: - $ref: "../schemas/TeamSummaryReportsDto.yaml" - description: Data related to the Identities that are managed by the provided identity + $ref: '../schemas/TeamSummaryReportsDto.yaml' + description: Data related to the Identities that are managed by the provided identity. diff --git a/idn/beta/schemas/UpdateSegmentEntitlementAssignmentInput.yaml b/idn/beta/schemas/UpdateSegmentEntitlementAssignmentInput.yaml index 2714dd8..33b86c9 100644 --- a/idn/beta/schemas/UpdateSegmentEntitlementAssignmentInput.yaml +++ b/idn/beta/schemas/UpdateSegmentEntitlementAssignmentInput.yaml @@ -6,11 +6,11 @@ properties: example: 313c28e5-3c3f-4bfe-bdd6-748afc123576 assignments: 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: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: './EntitlementRef.yaml' removals: type: array description: Array of entitlement ids to be removed from the segment items: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: './EntitlementRef.yaml' diff --git a/idn/beta/schemas/ViolationOwnerAssignmentConfig.yaml b/idn/beta/schemas/ViolationOwnerAssignmentConfig.yaml index e9161fc..002c607 100644 --- a/idn/beta/schemas/ViolationOwnerAssignmentConfig.yaml +++ b/idn/beta/schemas/ViolationOwnerAssignmentConfig.yaml @@ -16,6 +16,6 @@ properties: nullable: true ownerRef: allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + - $ref: '../../v3/schemas/OwnerDto.yaml' - nullable: true diff --git a/idn/beta/schemas/Workflow.yaml b/idn/beta/schemas/Workflow.yaml index bc8486b..5e0b017 100644 --- a/idn/beta/schemas/Workflow.yaml +++ b/idn/beta/schemas/Workflow.yaml @@ -8,31 +8,34 @@ allOf: executionCount: type: integer format: int32 - description: The number of times this workflow has been executed + description: The number of times this workflow has been executed. example: 2 failureCount: type: integer 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 created: type: string 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" creator: - allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that created the workflow. + type: object + description: Workflow creator's identity. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced - example: { - "type": "IDENTITY", - "id": "2c91808568c529c60168cca6f90c1313", - "name": "William Wilson" - } + type: string + description: Workflow creator's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Workflow creator's identity ID. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: Workflow creator's display name. + example: Michael Michaels - $ref: './WorkflowBody.yaml' \ No newline at end of file diff --git a/idn/beta/schemas/sod/models/Exception.yaml b/idn/beta/schemas/sod/models/Exception.yaml index ab4143e..4bbebca 100644 --- a/idn/beta/schemas/sod/models/Exception.yaml +++ b/idn/beta/schemas/sod/models/Exception.yaml @@ -17,10 +17,25 @@ properties: description: The time when this SOD exception is modified. example: "2020-01-01T00:00:00.000Z" sodPolicy: - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - example: "00fc6afc-af1d-43af-b350-8d632f4c56ca" + $ref: './SodPolicyDto.yaml' 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: type: string format: date-time diff --git a/idn/beta/schemas/sod/models/ExceptionOriginDto.yaml b/idn/beta/schemas/sod/models/ExceptionOriginDto.yaml new file mode 100644 index 0000000..fac8049 --- /dev/null +++ b/idn/beta/schemas/sod/models/ExceptionOriginDto.yaml @@ -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 diff --git a/idn/beta/schemas/sod/models/IdentityWithNewAccess.yaml b/idn/beta/schemas/sod/models/IdentityWithNewAccess.yaml index 9311115..5c10444 100644 --- a/idn/beta/schemas/sod/models/IdentityWithNewAccess.yaml +++ b/idn/beta/schemas/sod/models/IdentityWithNewAccess.yaml @@ -9,18 +9,26 @@ properties: type: string example: 2c91808568c529c60168cca6f90c1313 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 items: - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The types of objects supported for SOD violations + type: object + description: Entitlement including a specific set of access. properties: type: - enum: - - "ENTITLEMENT" - example: "ENTITLEMENT" - description: The type of object that is referenced + 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" example: - type: ENTITLEMENT id: 2c918087682f9a86016839c050861ab1 diff --git a/idn/beta/schemas/sod/models/SodPolicyDto.yaml b/idn/beta/schemas/sod/models/SodPolicyDto.yaml new file mode 100644 index 0000000..fc5b06a --- /dev/null +++ b/idn/beta/schemas/sod/models/SodPolicyDto.yaml @@ -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 diff --git a/idn/beta/schemas/sod/models/ViolationContext.yaml b/idn/beta/schemas/sod/models/ViolationContext.yaml index 44a4ec7..b7552df 100644 --- a/idn/beta/schemas/sod/models/ViolationContext.yaml +++ b/idn/beta/schemas/sod/models/ViolationContext.yaml @@ -2,7 +2,7 @@ type: object properties: policy: allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' + - $ref: './SodPolicyDto.yaml' - type: object properties: type: @@ -11,13 +11,13 @@ properties: name: type: string 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: type: enum: - "ENTITLEMENT" example: "ENTITLEMENT" - description: The type of object that is referenced + description: The type of object supported for SOD policy violations. conflictingAccessCriteria: $ref: './ExceptionAccessCriteria.yaml' nullable: false diff --git a/idn/beta/schemas/trigger/example-input/AccessItemApproverDto.yaml b/idn/beta/schemas/trigger/example-input/AccessItemApproverDto.yaml new file mode 100644 index 0000000..d1cb0a5 --- /dev/null +++ b/idn/beta/schemas/trigger/example-input/AccessItemApproverDto.yaml @@ -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 diff --git a/idn/beta/schemas/trigger/example-input/AccessItemRequestedForDto.yaml b/idn/beta/schemas/trigger/example-input/AccessItemRequestedForDto.yaml new file mode 100644 index 0000000..45bcb3c --- /dev/null +++ b/idn/beta/schemas/trigger/example-input/AccessItemRequestedForDto.yaml @@ -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 diff --git a/idn/beta/schemas/trigger/example-input/AccessItemRequesterDto.yaml b/idn/beta/schemas/trigger/example-input/AccessItemRequesterDto.yaml new file mode 100644 index 0000000..1f13b8b --- /dev/null +++ b/idn/beta/schemas/trigger/example-input/AccessItemRequesterDto.yaml @@ -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 diff --git a/idn/beta/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml b/idn/beta/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml index 557d828..cc60655 100644 --- a/idn/beta/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml +++ b/idn/beta/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml @@ -13,14 +13,7 @@ properties: example: 4b4d982dddff4267ab12f0f1e72b5a6d requestedFor: allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.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 + - $ref: './AccessItemRequestedForDto.yaml' requestedItems: description: The access items that are being requested. type: array @@ -65,11 +58,4 @@ properties: example: William needs this access for his day to day job activities. requestedBy: allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that initiated the access request. - properties: - type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced \ No newline at end of file + - $ref: './AccessItemRequesterDto.yaml' \ No newline at end of file diff --git a/idn/beta/schemas/trigger/example-input/AccessRequestPostApproval.yaml b/idn/beta/schemas/trigger/example-input/AccessRequestPostApproval.yaml index 6b1197f..92653ff 100644 --- a/idn/beta/schemas/trigger/example-input/AccessRequestPostApproval.yaml +++ b/idn/beta/schemas/trigger/example-input/AccessRequestPostApproval.yaml @@ -16,14 +16,7 @@ properties: - type - name allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity who the access request is for. - properties: - type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced + - $ref: './AccessItemRequestedForDto.yaml' requestedItemsStatus: description: Details on the outcome of each access item. type: array @@ -105,7 +98,7 @@ properties: - type - name allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' + - $ref: './AccessItemApproverDto.yaml' description: The identity of the approver. properties: type: @@ -119,11 +112,4 @@ properties: - type - name allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that initiated the access request. - properties: - type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced \ No newline at end of file + - $ref: './AccessItemRequesterDto.yaml' \ No newline at end of file diff --git a/idn/beta/schemas/trigger/example-input/AccessRequestPreApproval.yaml b/idn/beta/schemas/trigger/example-input/AccessRequestPreApproval.yaml index 0cf27d3..08cf398 100644 --- a/idn/beta/schemas/trigger/example-input/AccessRequestPreApproval.yaml +++ b/idn/beta/schemas/trigger/example-input/AccessRequestPreApproval.yaml @@ -16,14 +16,7 @@ properties: - type - name allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity who the access request is for. - properties: - type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced + - $ref: './AccessItemRequestedForDto.yaml' requestedItems: description: Details of the access items being requested. type: array @@ -72,11 +65,4 @@ properties: - type - name allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that initiated the access request. - properties: - type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced \ No newline at end of file + - $ref: './AccessItemRequesterDto.yaml' \ No newline at end of file diff --git a/idn/beta/schemas/trigger/example-input/AccountAggregationCompleted.yaml b/idn/beta/schemas/trigger/example-input/AccountAggregationCompleted.yaml index f1f70e8..4db03df 100644 --- a/idn/beta/schemas/trigger/example-input/AccountAggregationCompleted.yaml +++ b/idn/beta/schemas/trigger/example-input/AccountAggregationCompleted.yaml @@ -14,15 +14,23 @@ properties: - type - name - id - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The source from which the accounts were aggregated. + type: object + description: The source the accounts are being aggregated from. properties: type: - enum: - - SOURCE - description: The type of object that is referenced + type: string + description: The DTO type of the source the accounts are being aggregated from. + enum: + - 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: description: The overall status of the aggregation. enum: diff --git a/idn/beta/schemas/trigger/example-input/AccountAttributesChanged.yaml b/idn/beta/schemas/trigger/example-input/AccountAttributesChanged.yaml index 61f1ba6..c64a7c1 100644 --- a/idn/beta/schemas/trigger/example-input/AccountAttributesChanged.yaml +++ b/idn/beta/schemas/trigger/example-input/AccountAttributesChanged.yaml @@ -11,15 +11,23 @@ properties: - id - type - name - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity whose account attributes changed. + type: object + description: The identity whose account attributes were updated. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced + 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 source: required: - id diff --git a/idn/beta/schemas/trigger/example-input/AccountCorrelated.yaml b/idn/beta/schemas/trigger/example-input/AccountCorrelated.yaml index d7b3a7b..ffc887a 100644 --- a/idn/beta/schemas/trigger/example-input/AccountCorrelated.yaml +++ b/idn/beta/schemas/trigger/example-input/AccountCorrelated.yaml @@ -11,52 +11,68 @@ properties: - type - name - id - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that the account correlated with. + type: object + description: Identity the account is correlated with. properties: type: - enum: - - IDENTITY - description: The type of object that is referenced + type: string + description: DTO type of the identity the account is correlated with. + enum: + - 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: required: - id - type - name type: object - description: The source from which the account came from. + description: The source the accounts are being correlated from. properties: - id: - description: ID of the object to which this reference applies - type: string - example: 4e4d982dddff4267ab12f0f1e72b5a6d type: - type: string - enum: - - SOURCE + type: string + description: The DTO type of the source the accounts are being correlated from. + enum: + - 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: type: string - description: Human-readable display name of the object to which this reference applies - example: Corporate Active Directory + description: Display name of the source the accounts are being correlated from. + example: HR Active Directory account: + type: object + description: The correlated account. required: - id - name - nativeIdentity - type - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The account that was correlated. properties: type: + type: string + description: The correlated account's DTO type. enum: - ACCOUNT - description: The type of object that is referenced 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: type: string description: Unique ID of the account on the source. diff --git a/idn/beta/schemas/trigger/example-input/AccountUncorrelated.yaml b/idn/beta/schemas/trigger/example-input/AccountUncorrelated.yaml index 66698d4..3a45add 100644 --- a/idn/beta/schemas/trigger/example-input/AccountUncorrelated.yaml +++ b/idn/beta/schemas/trigger/example-input/AccountUncorrelated.yaml @@ -10,44 +10,67 @@ properties: - type - name - id - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that the account uncorrelated with. + type: object + description: Identity the account is uncorrelated with. properties: type: - enum: - - IDENTITY - description: The type of object that is referenced + type: string + description: DTO type of the identity the account is uncorrelated with. + enum: + - 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: required: - type - name - id - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The source from which the account came from. + type: object + description: The source the accounts are uncorrelated from. properties: type: - enum: - - SOURCE - description: The type of object that is referenced + type: string + description: The DTO type of the source the accounts are uncorrelated from. + enum: + - 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: + type: object + description: Uncorrelated account. required: - id - name - nativeIdentity - type - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The account that was uncorrelated. properties: type: enum: - ACCOUNT - description: The type of object that is referenced + description: Uncorrelated account's DTO type. 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: type: string description: Unique ID of the account on the source. diff --git a/idn/beta/schemas/trigger/example-input/IdentityAttributesChanged.yaml b/idn/beta/schemas/trigger/example-input/IdentityAttributesChanged.yaml index b928094..4366f19 100644 --- a/idn/beta/schemas/trigger/example-input/IdentityAttributesChanged.yaml +++ b/idn/beta/schemas/trigger/example-input/IdentityAttributesChanged.yaml @@ -9,15 +9,23 @@ properties: - id - type - name - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity who's attributes changed. + type: object + description: Identity whose attributes changed. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced + type: string + description: DTO type of identity whose attributes changed. + enum: + - IDENTITY + example: IDENTITY + 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: description: A list of one or more identity attributes that changed on the identity. type: array diff --git a/idn/beta/schemas/trigger/example-input/IdentityCreated.yaml b/idn/beta/schemas/trigger/example-input/IdentityCreated.yaml index 3ef1e3c..a02396b 100644 --- a/idn/beta/schemas/trigger/example-input/IdentityCreated.yaml +++ b/idn/beta/schemas/trigger/example-input/IdentityCreated.yaml @@ -9,18 +9,26 @@ properties: - id - type - name - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that was created. + type: object + description: Created identity. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced + type: string + description: Created identity's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Created identity ID. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: Created identity's display name. + example: Michael Michaels attributes: 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 example: { "firstname": "John" diff --git a/idn/beta/schemas/trigger/example-input/IdentityDeleted.yaml b/idn/beta/schemas/trigger/example-input/IdentityDeleted.yaml index 5ef6f54..2d8cad0 100644 --- a/idn/beta/schemas/trigger/example-input/IdentityDeleted.yaml +++ b/idn/beta/schemas/trigger/example-input/IdentityDeleted.yaml @@ -9,18 +9,26 @@ properties: - id - type - name - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that was deleted. + type: object + description: Deleted identity. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced + type: string + description: Deleted identity's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Deleted identity ID. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: Deleted identity's display name. + example: Michael Michaels attributes: 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 example: { "firstname": "John" diff --git a/idn/beta/schemas/trigger/example-input/ProvisioningCompleted.yaml b/idn/beta/schemas/trigger/example-input/ProvisioningCompleted.yaml index 506830c..2a973c7 100644 --- a/idn/beta/schemas/trigger/example-input/ProvisioningCompleted.yaml +++ b/idn/beta/schemas/trigger/example-input/ProvisioningCompleted.yaml @@ -38,30 +38,46 @@ properties: - id - type - name - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: Reference to the identity who is the target of the provisioning request. + type: object + description: Provisioning recpient. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced + type: string + description: Provisioning recipient DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Provisioning recipient's identity ID. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: Provisioning recipient's display name. + example: Michael Michaels requester: nullable: true required: - id - type - name - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: Reference to the identity (if any) who submitted the provisioning request. + type: object + description: Provisioning requester's identity. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced + type: string + description: Provisioning requester's DTO type. + enum: + - IDENTITY + example: IDENTITY + 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: type: array description: A list of provisioning instructions to perform on an account-by-account basis. diff --git a/idn/beta/schemas/trigger/example-input/SourceCreated.yaml b/idn/beta/schemas/trigger/example-input/SourceCreated.yaml index b78414c..5dc19ed 100644 --- a/idn/beta/schemas/trigger/example-input/SourceCreated.yaml +++ b/idn/beta/schemas/trigger/example-input/SourceCreated.yaml @@ -34,12 +34,20 @@ properties: - id - name - type - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that created the source. + type: object + description: Identity who created the source. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced \ No newline at end of file + type: string + description: DTO type of identity who created the source. + enum: + - IDENTITY + example: IDENTITY + 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 \ No newline at end of file diff --git a/idn/beta/schemas/trigger/example-input/SourceDeleted.yaml b/idn/beta/schemas/trigger/example-input/SourceDeleted.yaml index 3a024e2..c498f5c 100644 --- a/idn/beta/schemas/trigger/example-input/SourceDeleted.yaml +++ b/idn/beta/schemas/trigger/example-input/SourceDeleted.yaml @@ -34,12 +34,20 @@ properties: - id - name - type - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity that deleted the source. + type: object + description: Identity who deleted the source. properties: type: - enum: - - "IDENTITY" - example: "IDENTITY" - description: The type of object that is referenced \ No newline at end of file + type: string + description: DTO type of identity who deleted the source. + enum: + - IDENTITY + example: IDENTITY + 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 \ No newline at end of file diff --git a/idn/beta/schemas/trigger/example-input/SourceUpdated.yaml b/idn/beta/schemas/trigger/example-input/SourceUpdated.yaml index babe2ea..a7b7422 100644 --- a/idn/beta/schemas/trigger/example-input/SourceUpdated.yaml +++ b/idn/beta/schemas/trigger/example-input/SourceUpdated.yaml @@ -33,12 +33,20 @@ properties: required: - type - name - allOf: - - $ref: '../../../../v3/schemas/BaseReferenceDto.yaml' - description: The identity or system that performed the update. + type: object + description: Identity who updated the source. properties: type: - enum: - - IDENTITY + type: string + description: DTO type of identity who updated the source. + enum: + - IDENTITY example: IDENTITY - description: The type of object that is referenced \ No newline at end of file + 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 \ No newline at end of file diff --git a/idn/beta/schemas/workgroups/BulkWorkgroupMembersRequest.yaml b/idn/beta/schemas/workgroups/BulkWorkgroupMembersRequest.yaml index 9d2b4f3..bc03e89 100644 --- a/idn/beta/schemas/workgroups/BulkWorkgroupMembersRequest.yaml +++ b/idn/beta/schemas/workgroups/BulkWorkgroupMembersRequest.yaml @@ -1,7 +1,23 @@ description: List of identities to be added or removed to a Governance Group members list. type: array 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: [ { diff --git a/idn/beta/schemas/workgroups/WorkgroupDto.yaml b/idn/beta/schemas/workgroups/WorkgroupDto.yaml index dad35d9..9baa84d 100644 --- a/idn/beta/schemas/workgroups/WorkgroupDto.yaml +++ b/idn/beta/schemas/workgroups/WorkgroupDto.yaml @@ -1,30 +1,30 @@ type: object properties: owner: - $ref: "../../../v3/schemas/BaseReferenceDto.yaml" - description: Owner of the Governance Group + $ref: '../../../v3/schemas/OwnerDto.yaml' + description: Governance group owner. id: type: string - description: ID of the object to which this reference applies + description: Governance group ID. example: 2c91808568c529c60168cca6f90c1313 readOnly: true name: type: string - description: Name of the Governance Group + description: Governance group name. example: DB Access Governance Group description: type: string - description: Description of the Governance Group + description: Governance group description. example: Description of the Governance Group memberCount: type: integer format: int64 example: 1641498673000 readOnly: true - description: Number of members in the Governance Group. + description: Number of members in the governance group. connectionCount: type: integer format: int64 example: 1641498673000 - description: Number of connections in the Governance Group. + description: Number of connections in the governance group. readOnly: true \ No newline at end of file diff --git a/idn/v3/EntitlementRef.yaml b/idn/v3/EntitlementRef.yaml new file mode 100644 index 0000000..53e2cc2 --- /dev/null +++ b/idn/v3/EntitlementRef.yaml @@ -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" \ No newline at end of file diff --git a/idn/v3/paths/identity-profile-lifecycle-state.yaml b/idn/v3/paths/identity-profile-lifecycle-state.yaml index 4638884..003f1be 100644 --- a/idn/v3/paths/identity-profile-lifecycle-state.yaml +++ b/idn/v3/paths/identity-profile-lifecycle-state.yaml @@ -137,7 +137,7 @@ delete: - Lifecycle States summary: Delete Lifecycle State by ID 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. security: @@ -163,7 +163,7 @@ delete: content: application/json: schema: - $ref: '../schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/LifecyclestateDeleted.yaml' '400': $ref: '../responses/400.yaml' '401': diff --git a/idn/v3/paths/role-bulk-delete.yaml b/idn/v3/paths/role-bulk-delete.yaml index a01cecb..54db24e 100644 --- a/idn/v3/paths/role-bulk-delete.yaml +++ b/idn/v3/paths/role-bulk-delete.yaml @@ -26,7 +26,7 @@ post: content: application/json: schema: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/TaskResultDto.yaml' example: { "type": "TASK_RESULT", diff --git a/idn/v3/schemas/AccessItemRequestedFor.yaml b/idn/v3/schemas/AccessItemRequestedFor.yaml new file mode 100644 index 0000000..45bcb3c --- /dev/null +++ b/idn/v3/schemas/AccessItemRequestedFor.yaml @@ -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 diff --git a/idn/v3/schemas/AccessItemRequester.yaml b/idn/v3/schemas/AccessItemRequester.yaml new file mode 100644 index 0000000..1f13b8b --- /dev/null +++ b/idn/v3/schemas/AccessItemRequester.yaml @@ -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 diff --git a/idn/v3/schemas/AccessItemReviewedBy.yaml b/idn/v3/schemas/AccessItemReviewedBy.yaml new file mode 100644 index 0000000..e1f29f7 --- /dev/null +++ b/idn/v3/schemas/AccessItemReviewedBy.yaml @@ -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 diff --git a/idn/v3/schemas/ApprovalStatusDto.yaml b/idn/v3/schemas/ApprovalStatusDto.yaml index 7332314..2340b53 100644 --- a/idn/v3/schemas/ApprovalStatusDto.yaml +++ b/idn/v3/schemas/ApprovalStatusDto.yaml @@ -6,17 +6,26 @@ properties: True if the request for this item was forwarded from one owner to another. example: false originalOwner: - $ref: "./BaseReferenceDto.yaml" - description: >- - Base identity/workgroup reference object representing the original owner, - if forwarded. + 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 currentOwner: - $ref: "./BaseReferenceDto.yaml" - description: >- - Base reference of approver that will make decision. - reviewedBy: - $ref: "./BaseReferenceDto.yaml" - description: The identity who has reviewed the approval. + $ref: './AccessItemReviewedBy.yaml' modified: type: string format: date-time diff --git a/idn/v3/schemas/AttrSyncSource.yaml b/idn/v3/schemas/AttrSyncSource.yaml new file mode 100644 index 0000000..bf709aa --- /dev/null +++ b/idn/v3/schemas/AttrSyncSource.yaml @@ -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 diff --git a/idn/v3/schemas/BeforeProvisioningRuleDto.yaml b/idn/v3/schemas/BeforeProvisioningRuleDto.yaml new file mode 100644 index 0000000..e0f3449 --- /dev/null +++ b/idn/v3/schemas/BeforeProvisioningRuleDto.yaml @@ -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 diff --git a/idn/v3/schemas/CancelledRequestDetails.yaml b/idn/v3/schemas/CancelledRequestDetails.yaml index a042384..f980018 100644 --- a/idn/v3/schemas/CancelledRequestDetails.yaml +++ b/idn/v3/schemas/CancelledRequestDetails.yaml @@ -3,12 +3,12 @@ properties: comment: type: string 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: - $ref: './BaseReferenceDto.yaml' + $ref: '../../v3/schemas/OwnerDto.yaml' modified: type: string 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' description: Provides additional details for a request that has been cancelled. \ No newline at end of file diff --git a/idn/v3/schemas/CertificationReferenceDto.yaml b/idn/v3/schemas/CertificationReferenceDto.yaml new file mode 100644 index 0000000..87545a1 --- /dev/null +++ b/idn/v3/schemas/CertificationReferenceDto.yaml @@ -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 diff --git a/idn/v3/schemas/CommentDto.yaml b/idn/v3/schemas/CommentDto.yaml index 52b2944..026c52d 100644 --- a/idn/v3/schemas/CommentDto.yaml +++ b/idn/v3/schemas/CommentDto.yaml @@ -2,23 +2,28 @@ type: object properties: comment: type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat + nullable: true + description: Comment content. + example: This is a comment. author: type: object properties: type: - $ref: './DtoType.yaml' + type: string + description: DTO type of the commenting identity. + enum: + - IDENTITY + example: IDENTITY id: type: string - description: ID of the author + description: ID of the commenting identity. example: 2c91808568c529c60168cca6f90c1313 name: type: string - description: Human-readable display name of the identity making the comment + description: Display name of the commenting identity. example: Adam Kennedy created: type: string format: 'date-time' - description: Date and time comment was created + description: Date and time comment was created. example: '2017-07-11T18:45:37.098Z' \ No newline at end of file diff --git a/idn/v3/schemas/CompletedApproval.yaml b/idn/v3/schemas/CompletedApproval.yaml index 8483178..64343c7 100644 --- a/idn/v3/schemas/CompletedApproval.yaml +++ b/idn/v3/schemas/CompletedApproval.yaml @@ -27,17 +27,13 @@ properties: $ref: './AccessRequestType.yaml' description: If the access-request was for granting or revoking access. requester: - $ref: './BaseReferenceDto.yaml' - description: The identity that requested the item. + $ref: './AccessItemRequester.yaml' requestedFor: - $ref: './BaseReferenceDto.yaml' - description: The identity for whom the item is requested for. + $ref: './AccessItemRequestedFor.yaml' reviewedBy: - $ref: './BaseReferenceDto.yaml' - description: The identity who has reviewed the approval. + $ref: './AccessItemReviewedBy.yaml' owner: - $ref: './BaseReferenceDto.yaml' - description: The owner or approver of the approval. + $ref: './OwnerDto.yaml' requestedObject: $ref: './RequestableObjectReference.yaml' description: The requested access item. diff --git a/idn/v3/schemas/CreatePersonalAccessTokenResponse.yaml b/idn/v3/schemas/CreatePersonalAccessTokenResponse.yaml index 49a07ab..8bdc412 100644 --- a/idn/v3/schemas/CreatePersonalAccessTokenResponse.yaml +++ b/idn/v3/schemas/CreatePersonalAccessTokenResponse.yaml @@ -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. example: "NodeJS Integration" owner: - $ref: './BaseReferenceDto.yaml' - description: Details about the owner of the personal access token. + $ref: '../../v3/schemas/PatOwner.yaml' created: type: string format: 'date-time' diff --git a/idn/v3/schemas/CurrentWorkItemOwnerDto.yaml b/idn/v3/schemas/CurrentWorkItemOwnerDto.yaml new file mode 100644 index 0000000..2457eeb --- /dev/null +++ b/idn/v3/schemas/CurrentWorkItemOwnerDto.yaml @@ -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 \ No newline at end of file diff --git a/idn/v3/schemas/EntitlementDto.yaml b/idn/v3/schemas/EntitlementDto.yaml index f4f4302..2a6e717 100644 --- a/idn/v3/schemas/EntitlementDto.yaml +++ b/idn/v3/schemas/EntitlementDto.yaml @@ -37,9 +37,4 @@ allOf: type: boolean example: false source: - $ref: "./BaseReferenceDto.yaml" - description: Reference to the source this entitlment belongs to. - example: - - type: "SOURCE" - id: "2c9180835d191a86015d28455b4b232a" - name: "HR Active Directory" + $ref: '../../v3/schemas/EntitlementSource.yaml' diff --git a/idn/v3/schemas/EntitlementRef.yaml b/idn/v3/schemas/EntitlementRef.yaml new file mode 100644 index 0000000..53e2cc2 --- /dev/null +++ b/idn/v3/schemas/EntitlementRef.yaml @@ -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" \ No newline at end of file diff --git a/idn/v3/schemas/EntitlementSource.yaml b/idn/v3/schemas/EntitlementSource.yaml new file mode 100644 index 0000000..eba18f9 --- /dev/null +++ b/idn/v3/schemas/EntitlementSource.yaml @@ -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 diff --git a/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml b/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml index 3deb514..5c75203 100644 --- a/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml +++ b/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml @@ -17,8 +17,7 @@ properties: description: Scopes of the personal access token. example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ] owner: - $ref: './BaseReferenceDto.yaml' - description: Details about the owner of the personal access token. + $ref: '../../v3/schemas/PatOwner.yaml' created: type: string format: 'date-time' diff --git a/idn/v3/schemas/IdentityPreviewResponse.yaml b/idn/v3/schemas/IdentityPreviewResponse.yaml index 1081362..22c6897 100644 --- a/idn/v3/schemas/IdentityPreviewResponse.yaml +++ b/idn/v3/schemas/IdentityPreviewResponse.yaml @@ -1,7 +1,23 @@ type: object properties: 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: type: array items: diff --git a/idn/v3/schemas/IdentityProfileExportedObject.yaml b/idn/v3/schemas/IdentityProfileExportedObject.yaml index dc8fcdb..4fe6a4c 100644 --- a/idn/v3/schemas/IdentityProfileExportedObject.yaml +++ b/idn/v3/schemas/IdentityProfileExportedObject.yaml @@ -1,5 +1,5 @@ type: object -description: Identity Profile exported object +description: Identity profile exported object. properties: version: type: integer @@ -7,6 +7,45 @@ properties: description: Version or object from the target service. format: 'int32' 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: $ref: '../schemas/IdentityProfile.yaml' diff --git a/idn/v3/schemas/IdentityUpdatedAccountAttributesDto.yaml b/idn/v3/schemas/IdentityUpdatedAccountAttributesDto.yaml new file mode 100644 index 0000000..42b0970 --- /dev/null +++ b/idn/v3/schemas/IdentityUpdatedAccountAttributesDto.yaml @@ -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 \ No newline at end of file diff --git a/idn/v3/schemas/IdentityWithNewAccess.yaml b/idn/v3/schemas/IdentityWithNewAccess.yaml index 859be3f..886ade5 100644 --- a/idn/v3/schemas/IdentityWithNewAccess.yaml +++ b/idn/v3/schemas/IdentityWithNewAccess.yaml @@ -5,14 +5,15 @@ required: type: object properties: identityId: - description: Set of identity id's to be checked. + description: Set of identity IDs to be checked. type: string example: '2c91809050db617d0150e0bf3215385e' accessRefs: description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. type: array items: - $ref: './BaseReferenceDto.yaml' + allOf: + - $ref: './EntitlementRef.yaml' clientMetadata: type: object additionalProperties: diff --git a/idn/v3/schemas/ImportObject.yaml b/idn/v3/schemas/ImportObject.yaml new file mode 100644 index 0000000..8ae099d --- /dev/null +++ b/idn/v3/schemas/ImportObject.yaml @@ -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 \ No newline at end of file diff --git a/idn/v3/schemas/LifecyclestateDeleted.yaml b/idn/v3/schemas/LifecyclestateDeleted.yaml new file mode 100644 index 0000000..15ea4f9 --- /dev/null +++ b/idn/v3/schemas/LifecyclestateDeleted.yaml @@ -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 diff --git a/idn/v3/schemas/ManualWorkItemDetails.yaml b/idn/v3/schemas/ManualWorkItemDetails.yaml index 42cf890..fdf5ee8 100644 --- a/idn/v3/schemas/ManualWorkItemDetails.yaml +++ b/idn/v3/schemas/ManualWorkItemDetails.yaml @@ -5,13 +5,43 @@ properties: description: True if the request for this item was forwarded from one owner to another. example: true originalOwner: - $ref: './BaseReferenceDto.yaml' - description: >- - Base identity/workgroup reference object representing the original owner, if forwarded. - currentOwner: - $ref: './BaseReferenceDto.yaml' - description: >- - Base reference of approver that will make decision. + type: object + description: Identity of original work item owner, if the work item has been 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: + 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 modified: type: string format: date-time diff --git a/idn/v3/schemas/ObjectImportResult.yaml b/idn/v3/schemas/ObjectImportResult.yaml index 62d2857..e6abb78 100644 --- a/idn/v3/schemas/ObjectImportResult.yaml +++ b/idn/v3/schemas/ObjectImportResult.yaml @@ -21,7 +21,7 @@ properties: description: References to objects that were created or updated by the import. type: array items: - $ref: '../schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/ImportObject.yaml' required: - infos - warnings diff --git a/idn/v3/schemas/OriginalApprovalOwnerDto.yaml b/idn/v3/schemas/OriginalApprovalOwnerDto.yaml new file mode 100644 index 0000000..7ab98f7 --- /dev/null +++ b/idn/v3/schemas/OriginalApprovalOwnerDto.yaml @@ -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 \ No newline at end of file diff --git a/idn/v3/schemas/OriginalWorkItemOwnerDto.yaml b/idn/v3/schemas/OriginalWorkItemOwnerDto.yaml new file mode 100644 index 0000000..c84e3fa --- /dev/null +++ b/idn/v3/schemas/OriginalWorkItemOwnerDto.yaml @@ -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 \ No newline at end of file diff --git a/idn/v3/schemas/OwnerDto.yaml b/idn/v3/schemas/OwnerDto.yaml new file mode 100644 index 0000000..9d96956 --- /dev/null +++ b/idn/v3/schemas/OwnerDto.yaml @@ -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 diff --git a/idn/v3/schemas/PatOwner.yaml b/idn/v3/schemas/PatOwner.yaml new file mode 100644 index 0000000..bbc0120 --- /dev/null +++ b/idn/v3/schemas/PatOwner.yaml @@ -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 diff --git a/idn/v3/schemas/PendingApproval.yaml b/idn/v3/schemas/PendingApproval.yaml index b92d7b7..1dde49f 100644 --- a/idn/v3/schemas/PendingApproval.yaml +++ b/idn/v3/schemas/PendingApproval.yaml @@ -27,14 +27,27 @@ properties: $ref: './AccessRequestType.yaml' description: If the access-request was for granting or revoking access. requester: - $ref: './BaseReferenceDto.yaml' - description: The identity that requested the item. + $ref: './AccessItemRequester.yaml' requestedFor: - $ref: './BaseReferenceDto.yaml' - description: The identity for whom the item is requested for. + $ref: './AccessItemRequestedFor.yaml' owner: - $ref: './BaseReferenceDto.yaml' - description: The owner or approver of the approval. + 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 requestedObject: $ref: './RequestableObjectReference.yaml' description: The requested access item. diff --git a/idn/v3/schemas/ProvisioningConfig.yaml b/idn/v3/schemas/ProvisioningConfig.yaml index f03425e..167910a 100644 --- a/idn/v3/schemas/ProvisioningConfig.yaml +++ b/idn/v3/schemas/ProvisioningConfig.yaml @@ -11,19 +11,7 @@ properties: type: array items: allOf: - - $ref: '../schemas/BaseReferenceDto.yaml' - properties: - type: - description: The type of object being referenced - enum: - - SOURCE - example: SOURCE - id: - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - name: - description: Human-readable display name of the source - example: My Source + - $ref: '../../v3/schemas/ServiceDeskSource.yaml' example: - type: "SOURCE" id: "2c9180855d191c59015d291ceb051111" diff --git a/idn/v3/schemas/ReportResultReference.yaml b/idn/v3/schemas/ReportResultReference.yaml index a2d9d29..151360d 100644 --- a/idn/v3/schemas/ReportResultReference.yaml +++ b/idn/v3/schemas/ReportResultReference.yaml @@ -1,10 +1,10 @@ allOf: -- $ref: '../schemas/BaseReferenceDto.yaml' +- $ref: '../../v3/schemas/SodReportResultDto.yaml' - type : object properties: status: type: string - description: Status of a violation report + description: Status of a SOD policy violation report. enum: - SUCCESS - WARNING diff --git a/idn/v3/schemas/RequestedItemStatus.yaml b/idn/v3/schemas/RequestedItemStatus.yaml index d09887b..f11a0f6 100644 --- a/idn/v3/schemas/RequestedItemStatus.yaml +++ b/idn/v3/schemas/RequestedItemStatus.yaml @@ -51,11 +51,9 @@ properties: description: When the request was created. example: "2019-08-23T18:40:35.772Z" requester: - $ref: './BaseReferenceDto.yaml' - description: The identity that requested the item. + $ref: './AccessItemRequester.yaml' requestedFor: - $ref: './BaseReferenceDto.yaml' - description: The identity for whom the Access Request Status is requested for. + $ref: './AccessItemRequestedFor.yaml' requesterComment: $ref: './CommentDto.yaml' nullable: true diff --git a/idn/v3/schemas/SelfImportExportDto.yaml b/idn/v3/schemas/SelfImportExportDto.yaml new file mode 100644 index 0000000..082d8ef --- /dev/null +++ b/idn/v3/schemas/SelfImportExportDto.yaml @@ -0,0 +1,40 @@ +type: object +description: Self block for imported/exported object. +properties: + type: + type: string + description: Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. + 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: Imported/exported object's ID. + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Imported/exported object's display name. + example: HR Active Directory diff --git a/idn/v3/schemas/ServiceDeskIntegrationDto.yaml b/idn/v3/schemas/ServiceDeskIntegrationDto.yaml index a1fde65..907f62e 100644 --- a/idn/v3/schemas/ServiceDeskIntegrationDto.yaml +++ b/idn/v3/schemas/ServiceDeskIntegrationDto.yaml @@ -21,44 +21,33 @@ allOf: default: ServiceNowSDIM example: ServiceNowSDIM ownerRef: - allOf: - - $ref: '../schemas/BaseReferenceDto.yaml' - description: Reference to the identity that is the owner of this Service Desk integration + type: object + description: Source for Service Desk integration template. properties: type: - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY + type: string + description: DTO type of source for service desk integration template. + enum: + - SOURCE + example: SOURCE id: - description: ID of the identity - example: 2c91808568c529c60168cca6f90c1313 + type: string + description: ID of source for service desk integration template. + example: 2c9180835d191a86015d28455b4b232a name: - description: Human-readable display name of the identity - example: MyName + type: string + description: Human-readable name of source for service desk integration template. + example: HR Active Directory clusterRef: allOf: - - $ref: '../schemas/BaseReferenceDto.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 + - $ref: '../../v3/schemas/SourceClusterDto.yaml' 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 example: xyzzy999 deprecated: true 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 items: type: string @@ -79,17 +68,4 @@ allOf: } beforeProvisioningRule: allOf: - - $ref: '../schemas/BaseReferenceDto.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 + - $ref: '../../v3/schemas/BeforeProvisioningRuleDto.yaml' diff --git a/idn/v3/schemas/ServiceDeskSource.yaml b/idn/v3/schemas/ServiceDeskSource.yaml new file mode 100644 index 0000000..c40e6ae --- /dev/null +++ b/idn/v3/schemas/ServiceDeskSource.yaml @@ -0,0 +1,17 @@ +type: object +description: Source for Service Desk integration template. +properties: + type: + type: string + description: DTO type of source for service desk integration template. + enum: + - SOURCE + example: SOURCE + id: + type: string + description: ID of source for service desk integration template. + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable name of source for service desk integration template. + example: HR Active Directory diff --git a/idn/v3/schemas/SodPolicy.yaml b/idn/v3/schemas/SodPolicy.yaml index eea05b1..a402acc 100644 --- a/idn/v3/schemas/SodPolicy.yaml +++ b/idn/v3/schemas/SodPolicy.yaml @@ -27,7 +27,7 @@ properties: example: "This policy ensures compliance of xyz" nullable: true ownerRef: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/OwnerDto.yaml' externalPolicyReference: type: string description: Optional External Policy Reference diff --git a/idn/v3/schemas/SodPolicyDto.yaml b/idn/v3/schemas/SodPolicyDto.yaml new file mode 100644 index 0000000..fc5b06a --- /dev/null +++ b/idn/v3/schemas/SodPolicyDto.yaml @@ -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 diff --git a/idn/v3/schemas/SodPolicySchedule.yaml b/idn/v3/schemas/SodPolicySchedule.yaml index e5b20e6..e8efeea 100644 --- a/idn/v3/schemas/SodPolicySchedule.yaml +++ b/idn/v3/schemas/SodPolicySchedule.yaml @@ -25,7 +25,7 @@ properties: recipients: type: array items: - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + $ref: '../../v3/schemas/SodRecipient.yaml' emailEmptyResults: type: boolean description: Indicates if empty results need to be emailed diff --git a/idn/v3/schemas/SodRecipient.yaml b/idn/v3/schemas/SodRecipient.yaml new file mode 100644 index 0000000..867aa8e --- /dev/null +++ b/idn/v3/schemas/SodRecipient.yaml @@ -0,0 +1,17 @@ +type: object +description: SOD policy recipient. +properties: + type: + type: string + description: SOD policy recipient DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: SOD policy recipient's identity ID. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: SOD policy recipient's display name. + example: Michael Michaels diff --git a/idn/v3/schemas/SodReportResultDto.yaml b/idn/v3/schemas/SodReportResultDto.yaml new file mode 100644 index 0000000..1bc73cf --- /dev/null +++ b/idn/v3/schemas/SodReportResultDto.yaml @@ -0,0 +1,17 @@ +type: object +description: SOD policy violation report result. +properties: + type: + type: string + description: SOD policy violation report result DTO type. + enum: + - REPORT_RESULT + example: REPORT_RESULT + id: + type: string + description: SOD policy violation report result ID. + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable name of the SOD policy violation report result. + example: SOD Policy 1 Violation diff --git a/idn/v3/schemas/SodViolationCheckResult.yaml b/idn/v3/schemas/SodViolationCheckResult.yaml index 9d6b959..18ce24d 100644 --- a/idn/v3/schemas/SodViolationCheckResult.yaml +++ b/idn/v3/schemas/SodViolationCheckResult.yaml @@ -4,7 +4,7 @@ properties: message: $ref: './ErrorMessageDto.yaml' description: >- - If the request failed, includes any error message that was generated. + If the request failed, this includes any error message that was generated. example: - locale: "en-US" localeOrigin: "DEFAULT" @@ -25,13 +25,8 @@ properties: $ref: './SodViolationContext.yaml' violatedPolicies: type: array - description: A list of the Policies that were violated + description: A list of the SOD policies that were violated. items: - $ref: './BaseReferenceDto.yaml' - description: Reference to the policy that was violated - example: - - type: "SOD_POLICY" - id: "69129440-422d-4a23-aadd-35c828d5bfda" - name: 'HR Policy' + $ref: './SodPolicyDto.yaml' diff --git a/idn/v3/schemas/SodViolationContext.yaml b/idn/v3/schemas/SodViolationContext.yaml index 24a1869..31bbee8 100644 --- a/idn/v3/schemas/SodViolationContext.yaml +++ b/idn/v3/schemas/SodViolationContext.yaml @@ -2,8 +2,7 @@ description: The contextual information of the violated criteria type: object properties: policy: - $ref: "./BaseReferenceDto.yaml" - description: Reference to the Policy that is being violated. + $ref: './SodPolicyDto.yaml' conflictingAccessCriteria: type: object description: The object which contains the left and right hand side of the entitlements that got violated according to the policy. diff --git a/idn/v3/schemas/SourceClusterDto.yaml b/idn/v3/schemas/SourceClusterDto.yaml new file mode 100644 index 0000000..9ac4429 --- /dev/null +++ b/idn/v3/schemas/SourceClusterDto.yaml @@ -0,0 +1,17 @@ +type: object +description: Source cluster. +properties: + type: + type: string + description: Source cluster DTO type. + enum: + - CLUSTER + example: CLUSTER + id: + type: string + description: Source cluster ID. + example: 2c9180847a7fccdd017aa5896f9f4f6f + name: + type: string + description: Source cluster display name. + example: Training VA diff --git a/idn/v3/schemas/SourceDto.yaml b/idn/v3/schemas/SourceDto.yaml new file mode 100644 index 0000000..7fd0e15 --- /dev/null +++ b/idn/v3/schemas/SourceDto.yaml @@ -0,0 +1,17 @@ +type: object +description: Source basic details. +properties: + type: + type: string + description: Source DTO type. + enum: + - SOURCE + example: SOURCE + id: + type: string + description: Source ID. + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Source display name. + example: HR Active Directory diff --git a/idn/v3/schemas/TaggedObject.yaml b/idn/v3/schemas/TaggedObject.yaml index e6cbbc3..b6abefa 100644 --- a/idn/v3/schemas/TaggedObject.yaml +++ b/idn/v3/schemas/TaggedObject.yaml @@ -1,7 +1,8 @@ type: object +description: Tagged object. properties: objectRef: - $ref: '../../v3/schemas/TaggedObjectDto.yaml' + $ref: '../../v3/schemas/TaggedObject.yaml' tags: type: array items: diff --git a/idn/v3/schemas/TaskResultDto.yaml b/idn/v3/schemas/TaskResultDto.yaml new file mode 100644 index 0000000..d0f2934 --- /dev/null +++ b/idn/v3/schemas/TaskResultDto.yaml @@ -0,0 +1,18 @@ +type: object +description: Task result. +properties: + type: + type: string + description: Task result DTO type. + enum: + - TASK_RESULT + example: TASK_RESULT + id: + type: string + description: Task result ID. + example: 464ae7bf791e49fdb74606a2e4a89635 + name: + type: string + description: Task result display name. + nullable: true + example: null diff --git a/idn/v3/schemas/ViolationOwnerAssignmentConfig.yaml b/idn/v3/schemas/ViolationOwnerAssignmentConfig.yaml index 8ea234e..a4ca11c 100644 --- a/idn/v3/schemas/ViolationOwnerAssignmentConfig.yaml +++ b/idn/v3/schemas/ViolationOwnerAssignmentConfig.yaml @@ -16,5 +16,5 @@ properties: nullable: true ownerRef: allOf: - - $ref: '../../v3/schemas/BaseReferenceDto.yaml' + - $ref: '../../v3/schemas/OwnerDto.yaml' - nullable: true diff --git a/idn/v3/schemas/WorkflowCreatorDto.yaml b/idn/v3/schemas/WorkflowCreatorDto.yaml new file mode 100644 index 0000000..368dd6c --- /dev/null +++ b/idn/v3/schemas/WorkflowCreatorDto.yaml @@ -0,0 +1,17 @@ +type: object +description: Workflow creator's identity. +properties: + type: + type: string + description: Workflow creator's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Workflow creator's identity ID. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: Workflow creator's display name. + example: Michael Michaels \ No newline at end of file diff --git a/idn/v3/schemas/WorkgroupMemberIdentities.yaml b/idn/v3/schemas/WorkgroupMemberIdentities.yaml new file mode 100644 index 0000000..6d8a190 --- /dev/null +++ b/idn/v3/schemas/WorkgroupMemberIdentities.yaml @@ -0,0 +1,17 @@ +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 \ No newline at end of file diff --git a/idn/v3/schemas/access/AccessProfile.yaml b/idn/v3/schemas/access/AccessProfile.yaml index 2f71227..322ec50 100644 --- a/idn/v3/schemas/access/AccessProfile.yaml +++ b/idn/v3/schemas/access/AccessProfile.yaml @@ -37,6 +37,7 @@ properties: $ref: './AccessProfileSourceRef.yaml' entitlements: type: array + nullable: true description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. items: $ref: './EntitlementRef.yaml' diff --git a/idn/v3/schemas/access/AccessProfileUsage.yaml b/idn/v3/schemas/access/AccessProfileUsage.yaml index 19ca1a1..34d938f 100644 --- a/idn/v3/schemas/access/AccessProfileUsage.yaml +++ b/idn/v3/schemas/access/AccessProfileUsage.yaml @@ -8,5 +8,21 @@ properties: type: array description: List of references to objects which are using the indicated Access Profile items: - $ref: '../BaseReferenceDto.yaml' + type: object + description: Role using the access profile. + properties: + type: + type: string + description: DTO type of role using the access profile. + enum: + - ROLE + example: ROLE + id: + type: string + description: ID of role using the access profile. + example: 2c8180857a9b3da0017aa03418480f9d + name: + type: string + description: Display name of role using the access profile. + example: Manager Role diff --git a/idn/v3/schemas/access/EntitlementRef.yaml b/idn/v3/schemas/access/EntitlementRef.yaml index c4c7e32..1c51beb 100644 --- a/idn/v3/schemas/access/EntitlementRef.yaml +++ b/idn/v3/schemas/access/EntitlementRef.yaml @@ -1,16 +1,17 @@ type: object +description: Entitlement including a specific set of access. properties: - id: - type: string - description: The ID of the Entitlement - example: 2c91809773dee32014e13e122092014e - type: - type: string - enum: - - ENTITLEMENT - description: The type of the Entitlement, will always be ENTITLEMENT - example: ENTITLEMENT - name: - type: string - description: The display name of the Entitlement - example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local" + 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" diff --git a/idn/v3/schemas/sod/models/IdentityWithNewAccess.yaml b/idn/v3/schemas/sod/models/IdentityWithNewAccess.yaml index d106230..5c10444 100644 --- a/idn/v3/schemas/sod/models/IdentityWithNewAccess.yaml +++ b/idn/v3/schemas/sod/models/IdentityWithNewAccess.yaml @@ -9,18 +9,26 @@ properties: type: string example: 2c91808568c529c60168cca6f90c1313 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 items: - allOf: - - $ref: '../../BaseReferenceDto.yaml' - description: The types of objects supported for SOD violations + type: object + description: Entitlement including a specific set of access. properties: type: - enum: - - "ENTITLEMENT" - example: "ENTITLEMENT" - description: The type of object that is referenced + 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" example: - type: ENTITLEMENT id: 2c918087682f9a86016839c050861ab1 diff --git a/idn/v3/schemas/sod/models/SodPolicyDto.yaml b/idn/v3/schemas/sod/models/SodPolicyDto.yaml new file mode 100644 index 0000000..fc5b06a --- /dev/null +++ b/idn/v3/schemas/sod/models/SodPolicyDto.yaml @@ -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 diff --git a/idn/v3/schemas/sod/models/ViolationContext.yaml b/idn/v3/schemas/sod/models/ViolationContext.yaml index 223cd1d..7871a63 100644 --- a/idn/v3/schemas/sod/models/ViolationContext.yaml +++ b/idn/v3/schemas/sod/models/ViolationContext.yaml @@ -2,7 +2,7 @@ type: object properties: policy: allOf: - - $ref: '../../BaseReferenceDto.yaml' + - $ref: './SodPolicyDto.yaml' - type: object properties: type: