From 63e80b2c1b375f1e94a08c751b28bfafa7d41f03 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Tue, 18 Feb 2025 21:08:11 +0000 Subject: [PATCH] Automated commit by github action: 13400066335 --- .../idn/v3/parameters/path/search/index.yaml | 2 +- static/api-specs/idn/v3/paths/search-get.yaml | 12 + .../api-specs/idn/v3/paths/search-post.yaml | 42 +- .../search/documents/AggregationResult.yaml | 2 +- .../search/documents/SearchDocuments.yaml | 8 + .../documents/examples/accessProfile.yaml | 50 +- .../documents/examples/accessProfiles.yaml | 60 +-- .../documents/examples/accountActivities.yaml | 73 +++ .../documents/examples/accountActivity.yaml | 68 +++ .../documents/examples/entitlement.yaml | 38 +- .../documents/examples/entitlements.yaml | 42 +- .../search/documents/examples/event.yaml | 43 +- .../search/documents/examples/events.yaml | 48 +- .../documents/examples/filterExists.yaml | 210 +++++++++ .../documents/examples/filterRange.yaml | 312 +++++++++++++ .../documents/examples/filterTerms.yaml | 208 +++++++++ .../search/documents/examples/identities.yaml | 430 +++++++++++++----- .../search/documents/examples/identity.yaml | 423 ++++++++++++----- .../documents/examples/queryFields.yaml | 198 ++++++++ .../documents/examples/queryInnerHit.yaml | 47 ++ .../documents/examples/queryTimeZone.yaml | 326 +++++++++++++ .../search/documents/examples/role.yaml | 46 +- .../search/documents/examples/roles.yaml | 40 +- .../documents/examples/typeAheadQuery.yaml | 26 ++ .../examples/typeAheadQueryNestedType.yaml | 7 + .../search/examples/filter-exists.yaml | 4 +- .../schemas/search/examples/filter-range.yaml | 4 +- .../schemas/search/examples/filter-terms.yaml | 2 +- .../search/examples/query-accessprofiles.yaml | 6 + .../examples/query-accountactivities.yaml | 6 + .../search/examples/query-entitlements.yaml | 6 + .../schemas/search/examples/query-events.yaml | 6 + .../search/examples/query-identities.yaml | 6 + .../search/examples/query-innerHit.yaml | 2 +- .../schemas/search/examples/query-roles.yaml | 6 + .../examples/typeAheadQuery-nestedType.yaml | 2 +- .../search/examples/typeAheadQuery.yaml | 2 +- .../schemas/search/model/access/Access.yaml | 3 +- .../search/model/access/AccessApps.yaml | 36 ++ .../access/AccessProfileEntitlement.yaml | 4 + .../model/access/AccessProfileRole.yaml | 4 + .../model/access/AccessProfileSummary.yaml | 4 + .../search/model/access/BaseAccess.yaml | 126 +++-- .../access/profile/AccessProfileDocument.yaml | 36 +- .../profile/AccessProfileDocuments.yaml | 4 + .../model/account/ActivityIdentity.yaml | 8 + .../search/model/account/BaseAccount.yaml | 14 + .../activity/AccountActivityDocument.yaml | 170 +++---- .../activity/AccountActivityDocuments.yaml | 4 + .../account/activity/AccountRequest.yaml | 2 + .../model/account/activity/Approval.yaml | 12 +- .../account/activity/AttributeRequest.yaml | 11 +- .../model/account/activity/ExpansionItem.yaml | 15 +- .../account/activity/OriginalRequest.yaml | 2 + .../search/model/account/activity/Result.yaml | 6 + .../search/model/base/BaseDocument.yaml | 6 +- .../search/model/base/DocumentFields.yaml | 18 + .../search/model/base/DocumentType.yaml | 2 - .../model/entitlement/BaseEntitlement.yaml | 1 + .../entitlement/EntitlementDocument.yaml | 72 ++- .../entitlement/EntitlementDocuments.yaml | 4 + .../search/model/event/EventDocument.yaml | 153 ++++--- .../search/model/event/EventDocuments.yaml | 15 + .../model/identity/IdentityDocument.yaml | 28 +- .../model/identity/IdentityDocuments.yaml | 4 + .../search/model/role/RoleDocument.yaml | 103 ++++- .../search/model/role/RoleDocuments.yaml | 4 + 67 files changed, 3000 insertions(+), 684 deletions(-) create mode 100644 static/api-specs/idn/v3/schemas/search/documents/SearchDocuments.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/accountActivities.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/accountActivity.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/filterExists.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/filterRange.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/filterTerms.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/queryFields.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/queryInnerHit.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/queryTimeZone.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/typeAheadQuery.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/documents/examples/typeAheadQueryNestedType.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/examples/query-accessprofiles.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/examples/query-accountactivities.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/examples/query-entitlements.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/examples/query-events.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/examples/query-identities.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/examples/query-roles.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/access/AccessApps.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocuments.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/account/ActivityIdentity.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocuments.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/account/activity/Result.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/base/DocumentFields.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocuments.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/event/EventDocuments.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocuments.yaml create mode 100644 static/api-specs/idn/v3/schemas/search/model/role/RoleDocuments.yaml diff --git a/static/api-specs/idn/v3/parameters/path/search/index.yaml b/static/api-specs/idn/v3/parameters/path/search/index.yaml index 2cade201c64b..4ca2abfa3b34 100644 --- a/static/api-specs/idn/v3/parameters/path/search/index.yaml +++ b/static/api-specs/idn/v3/parameters/path/search/index.yaml @@ -14,4 +14,4 @@ schema: - identities - roles required: true -example: accounts \ No newline at end of file +example: identities \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/search-get.yaml b/static/api-specs/idn/v3/paths/search-get.yaml index c4dcf9d7739f..0f0273b410d6 100644 --- a/static/api-specs/idn/v3/paths/search-get.yaml +++ b/static/api-specs/idn/v3/paths/search-get.yaml @@ -6,6 +6,16 @@ get: operationId: searchGet security: - userAuth: [ sp:search:read ] + - applicationAuth: [ sp:search:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN + - REPORT_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - HELPDESK summary: "Get a Document by ID" parameters: - $ref: '../parameters/path/search/index.yaml' @@ -20,6 +30,8 @@ get: examples: accessProfile: $ref: '../schemas/search/documents/examples/accessProfile.yaml' + accountActivity: + $ref: '../schemas/search/documents/examples/accountActivity.yaml' entitlement: $ref: '../schemas/search/documents/examples/entitlement.yaml' event: diff --git a/static/api-specs/idn/v3/paths/search-post.yaml b/static/api-specs/idn/v3/paths/search-post.yaml index f6cbbcec1bd5..26be0068708a 100644 --- a/static/api-specs/idn/v3/paths/search-post.yaml +++ b/static/api-specs/idn/v3/paths/search-post.yaml @@ -11,6 +11,16 @@ post: operationId: searchPost security: - userAuth: [ sp:search:read ] + - applicationAuth: [ sp:search:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN + - REPORT_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - HELPDESK summary: "Perform Search" parameters: - $ref: '../parameters/offset.yaml' @@ -22,6 +32,18 @@ post: schema: $ref: '../schemas/search/Search.yaml' examples: + accessProfiles: + $ref: '../schemas/search/examples/query-accessprofiles.yaml' + accountActivities: + $ref: '../schemas/search/examples/query-accountactivities.yaml' + entitlements: + $ref: '../schemas/search/examples/query-entitlements.yaml' + events: + $ref: '../schemas/search/examples/query-events.yaml' + identities: + $ref: '../schemas/search/examples/query-identities.yaml' + roles: + $ref: '../schemas/search/examples/query-roles.yaml' query-fields: $ref: '../schemas/search/examples/query-fields.yaml' query-timeZone: @@ -47,10 +69,12 @@ post: schema: type: array items: - $ref: '../schemas/search/documents/SearchDocument.yaml' + $ref: '../schemas/search/documents/SearchDocuments.yaml' examples: accessProfiles: $ref: '../schemas/search/documents/examples/accessProfiles.yaml' + accountActivities: + $ref: '../schemas/search/documents/examples/accountActivities.yaml' entitlements: $ref: '../schemas/search/documents/examples/entitlements.yaml' events: @@ -59,6 +83,22 @@ post: $ref: '../schemas/search/documents/examples/identities.yaml' roles: $ref: '../schemas/search/documents/examples/roles.yaml' + query-fields: + $ref: '../schemas/search/documents/examples/queryFields.yaml' + query-timeZone: + $ref: '../schemas/search/documents/examples/queryTimeZone.yaml' + query-innerHit: + $ref: '../schemas/search/documents/examples/queryInnerHit.yaml' + typeAheadQuery: + $ref: '../schemas/search/documents/examples/typeAheadQuery.yaml' + typeAheadQuery-nestedType: + $ref: '../schemas/search/documents/examples/typeAheadQueryNestedType.yaml' + filter-exists: + $ref: '../schemas/search/documents/examples/filterExists.yaml' + filter-range: + $ref: '../schemas/search/documents/examples/filterRange.yaml' + filter-terms: + $ref: '../schemas/search/documents/examples/filterTerms.yaml' headers: X-Total-Count: schema: diff --git a/static/api-specs/idn/v3/schemas/search/documents/AggregationResult.yaml b/static/api-specs/idn/v3/schemas/search/documents/AggregationResult.yaml index cc5ec4bfcf9b..31c19557bd0e 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/AggregationResult.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/AggregationResult.yaml @@ -32,4 +32,4 @@ properties: The results of the aggregation search query. type: array items: - $ref: 'SearchDocument.yaml' + $ref: 'SearchDocuments.yaml' diff --git a/static/api-specs/idn/v3/schemas/search/documents/SearchDocuments.yaml b/static/api-specs/idn/v3/schemas/search/documents/SearchDocuments.yaml new file mode 100644 index 000000000000..f8b336c98169 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/SearchDocuments.yaml @@ -0,0 +1,8 @@ +type: object +oneOf: + - $ref: '../model/access/profile/AccessProfileDocuments.yaml' + - $ref: '../model/account/activity/AccountActivityDocuments.yaml' + - $ref: '../model/entitlement/EntitlementDocuments.yaml' + - $ref: '../model/event/EventDocuments.yaml' + - $ref: '../model/identity/IdentityDocuments.yaml' + - $ref: '../model/role/RoleDocuments.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfile.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfile.yaml index bd8892b773dc..6fb6abda34a2 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfile.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfile.yaml @@ -1,29 +1,35 @@ summary: AccessProfile value: - id: '2c9180825a6c1adc015a71c9023f0818' - name: 'Cloud Eng' - description: 'Cloud Eng' - created: '2017-02-24T20:21:23.145Z' - modified: '2019-05-24T20:36:04.312Z' - synced: '2020-02-18T05:30:20.414Z' + id: 13b856dd9a264206954b63ecbb57a853 + name: Cloud Eng + description: Cloud Eng + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + entitlements: + - hasPermissions: false + attribute: memberOf + value: CN=Cloud Engineering,DC=sailpoint,DC=COM + schema: group + privileged: false + id: 7372eaddd75749bd89a2e76a363eb891 + name: Cloud Engineering + description: Cloud Engineering + entitlementCount: 1 + segments: [] + segmentCount: 0 + apps: [] + created: 2024-09-16T17:41:25Z + modified: 2024-09-16T19:30:54Z + synced: 2025-02-12T06:32:40.156Z enabled: true requestable: true requestCommentsRequired: false owner: - id: 'ff8081815757d36a015757d42e56031e' - name: 'SailPoint Support' - type: 'IDENTITY' - email: 'cloud-support@sailpoint.com' - source: - id: 'ff8081815757d4fb0157588f3d9d008f' - name: 'Employees' - entitlements: - - id: '2c918084575812550157589064f33b89' - name: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' - description: mull - attribute: 'memberOf' - value: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' - entitlementCount: 1 + id: ff8081815757d36a015757d42e56031e + name: SailPoint Support + type: IDENTITY + email: cloud-support@sailpoint.com tags: - - 'TAG_1' - - 'TAG_2' + - TAG_1 + - TAG_2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfiles.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfiles.yaml index 928dd5695cb1..95f9a69964f1 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfiles.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfiles.yaml @@ -1,32 +1,40 @@ -summary: 'A collection of AccessProfiles' +summary: 'A collection of Access Profiles' value: - - id: '2c9180825a6c1adc015a71c9023f0818' - name: 'Cloud Eng' - _type: 'accessprofile' - description: 'Cloud Eng' - created: '2017-02-24T20:21:23.145Z' - modified: '2019-05-24T20:36:04.312Z' - synced: '2020-02-18T05:30:20.414Z' + - id: 13b856dd9a264206954b63ecbb57a853 + name: Cloud Eng + description: Cloud Eng + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + entitlements: + - hasPermissions: false + attribute: memberOf + value: CN=Cloud Engineering,DC=sailpoint,DC=com + schema: group + privileged: false + id: 7372eaddd75749bd89a2e76a363eb891 + name: Cloud Engineering + description: Cloud Engineering + entitlementCount: 1 + segments: [] + segmentCount: 0 + apps: [] + created: 2024-09-16T17:41:25Z + modified: 2024-09-16T19:30:54Z + synced: 2025-02-12T06:32:40.156Z enabled: true requestable: true requestCommentsRequired: false owner: - id: 'ff8081815757d36a015757d42e56031e' - name: 'SailPoint Support' - type: 'IDENTITY' - email: 'cloud-support@sailpoint.com' - source: - id: 'ff8081815757d4fb0157588f3d9d008f' - name: 'Employees' - entitlements: - - id: '2c918084575812550157589064f33b89' - name: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' - description: mull - attribute: 'memberOf' - value: 'CN=Cloud Engineering,DC=sailpoint,DC=COM' - entitlementCount: 1 + id: ff8081815757d36a015757d42e56031e + name: SailPoint Support + type: IDENTITY + email: cloud-support@sailpoint.com tags: - - 'TAG_1' - - 'TAG_2' - - + - TAG_1 + - TAG_2 + _type: accessprofile + type: accessprofile + pod: pod01-useast1 + org: org-name + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/accountActivities.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/accountActivities.yaml new file mode 100644 index 000000000000..f14520aabd3c --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/accountActivities.yaml @@ -0,0 +1,73 @@ +summary: 'A collection of Account Activities' +value: + - id: 6f76c3add1db4ba8bbe0d42aaceb7a07 + _type: accountactivity + type: accountactivity + requester: + name: Amos.Cunningham + id: ef1e2a36099447cb9448c68e1804dd9f + type: Identity + sources: Active Directory + created: '2025-01-02T21:45:59.795Z' + accountRequests: + - result: + status: committed + accountId: 'CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + op: Modify + provisioningTarget: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ADLDAPConnector + source: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ADLDAPConnector + attributeRequests: + - op: Add + name: memberOf + value: 'CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + stage: Completed + originalRequests: + - result: + status: Manual Task Created + accountId: 'CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + op: Modify + accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' + source: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ADLDAPConnector + attributeRequests: + - op: Add + name: memberOf + value: 'CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + expansionItems: [] + approvals: + - owner: + name: tina.smith + id: 322c6bce405a495a8e841a014b7d8410 + type: Identity + result: Finished + attributeRequest: + op: Add + name: memberOf + value: + - 'CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' + modified: '2025-01-02T21:47:16.903Z' + source: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ADLDAPConnector + recipient: + name: Amos.Cunningham + id: ef1e2a36099447cb9448c68e1804dd9f + type: Identity + action: Access Request + modified: '2025-01-02T21:47:16.903Z' + trackingNumber: 051d09b0bb5b453d91f658ba7f1e3171 + status: Complete + pod: pod01-useast1 + org: org-name + synced: '2025-01-02T21:47:16.953Z' + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/accountActivity.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/accountActivity.yaml new file mode 100644 index 000000000000..35a5ee4063a6 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/accountActivity.yaml @@ -0,0 +1,68 @@ +summary: AccountActivity +value: + id: 6f76c3add1db4ba8bbe0d42aaceb7a07 + requester: + name: Amos.Cunningham + id: ef1e2a36099447cb9448c68e1804dd9f + type: Identity + synced: '2025-01-02T21:47:16.953Z' + sources: Active Directory + created: '2025-01-02T21:45:59.795Z' + accountRequests: + - result: + status: committed + accountId: 'CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + op: Modify + provisioningTarget: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ADLDAPConnector + source: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ADLDAPConnector + attributeRequests: + - op: Add + name: memberOf + value: 'CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + stage: Completed + originalRequests: + - result: + status: Manual Task Created + accountId: 'CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + op: Modify + accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' + source: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ADLDAPConnector + attributeRequests: + - op: Add + name: memberOf + value: 'CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + expansionItems: [] + approvals: + - owner: + name: tina.smith + id: 322c6bce405a495a8e841a014b7d8410 + type: Identity + result: Finished + attributeRequest: + op: Add + name: memberOf + value: + - 'CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' + modified: '2025-01-02T21:47:16.903Z' + source: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ADLDAPConnector + recipient: + name: Amos.Cunningham + id: ef1e2a36099447cb9448c68e1804dd9f + type: Identity + action: Access Request + modified: '2025-01-02T21:47:16.903Z' + trackingNumber: 051d09b0bb5b453d91f658ba7f1e3171 + status: Complete diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/entitlement.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/entitlement.yaml index 69a2654b602a..a0fd094e423c 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/entitlement.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/entitlement.yaml @@ -1,23 +1,21 @@ summary: Entitlement value: - id: '2c9180946ed0c43d016eec1a80892fbd' - name: 'entitlement.aa415ae7' - description: 'null' - attribute: 'groups' - value: 'entitlement.aa415ae7' - modified: '2019-12-09T19:19:50.154Z' - created: '2018-12-07T01:07:48Z' - synced: '2020-02-19T04:30:32.906Z' - displayName: 'entitlement.aa415ae7' - source: - id: '2c91808b6e9e6fb8016eec1a2b6f7b5f' - name: 'ODS-HR-Employees' - owner: - type: 'IDENTITY' - id: '2c9180858315595501831958427e5424' - name: 'Addie Lee' + id: 2c9180867dde18d1017de8ea1f5c130f + name: Vendor Creation + displayName: Vendor Creation + created: 2021-12-23T20:09:57.340Z + modified: 2023-05-02T06:31:19.357Z + attribute: groups + value: VC + sourceSchemaObjectType: group + schema: group privileged: false - identityCount: 68 - tags: - - 'TAG_1' - - 'TAG_2' + cloudGoverned: false + hash: 22ac1f7a13c8a462c67ee74f5fcbf06a277cce50 + description: Set up new AP vendors + requestable: false + source: + id: 2c9180887de347a7017de8e75fa5570a + type: SOURCE + name: Finance + containsDataAccess: "false" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/entitlements.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/entitlements.yaml index 5d297f2661c3..b65de3a9fb76 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/entitlements.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/entitlements.yaml @@ -1,19 +1,27 @@ -summary: A collection of Entitlements +summary: 'A collection of Entitlements' value: - - id: '2c9180946ed0c43d016eec1a80892fbd' - name: 'entitlement.aa415ae7' - _type: 'entitlement' - description: 'null' - attribute: 'groups' - value: 'entitlement.aa415ae7' - modified: '2019-12-09T19:19:50.154Z' - synced: '2020-02-19T04:30:32.906Z' - displayName: 'entitlement.aa415ae7' - source: - id: '2c91808b6e9e6fb8016eec1a2b6f7b5f' - name: 'ODS-HR-Employees' + - id: 2c9180867dde18d1017de8ea1f5c130f + name: Vendor Creation + displayName: Vendor Creation + created: 2021-12-23T20:09:57.340Z + modified: 2023-05-02T06:31:19.357Z + attribute: groups + value: VC + sourceSchemaObjectType: group + schema: group privileged: false - identityCount: 68 - tags: - - 'TAG_1' - - 'TAG_2' + cloudGoverned: false + hash: 22ac1f7a13c8a462c67ee74f5fcbf06a277cce50 + description: Set up new AP vendors + requestable: false + source: + id: 2c9180887de347a7017de8e75fa5570a + type: SOURCE + name: Finance + containsDataAccess: "false" + pod: pod01-useast1 + org: org-name + synced: 2024-11-07T16:29:06.131Z + _type: entitlement + type: entitlement + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/event.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/event.yaml index 9c06aae685ce..90d66d18a58f 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/event.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/event.yaml @@ -1,24 +1,27 @@ summary: Event value: - id: 'e092842f-c904-4b59-aac8-2544abeeef4b' - name: 'Update Task Schedule Passed' - created: '2020-02-17T16:23:18.327Z' - synced: '2020-02-17T16:23:18.388Z' - action: 'TASK_SCHEDULE_UPDATE_PASSED' - type: 'SYSTEM_CONFIG' - actor: - name: 'MantisTaskScheduler' + id: 001909ce8cc3b519436197105426b18b5fc6ca179803c0c3702e9038107bec78 + stack: wps + synced: 2023-06-01T22:01:38.170Z + created: 2023-06-01T22:01:37.818Z + objects: + - ACCOUNT + type: PROVISIONING + technicalName: ACCOUNT_MODIFY_PASSED target: - name: 'Perform provisioning activity search delete synchronization' - stack: 'tpe' - trackingNumber: 'c6b98bc39ece48b080826d16c76b166c' - ipAddress: '207.189.160.158' - details: "null" + name: Colt.Spears + actor: + name: System + name: Modify Account Passed + action: ModifyAccount attributes: - sourceName: 'SailPoint' - objects: - - 'TASK' - - 'SCHEDULE' - operation: 'UPDATE' - status: 'PASSED' - technicalName: 'TASK_SCHEDULE_UPDATE_PASSED' + accountUuid: "{2d1ec18a-84cc-4659-bf75-a1ce4d56a9c5}" + cloudAppName: Active Directory + appId: 5c71ff71195b4794a0b87e7cf36fb017 + sourceId: source + sourceName: Active Directory + accountName: CN=Colt Spears,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpoint,DC=com + interface: Identity Refresh + trackingNumber: 1f74901adbc0412d9fa51314195155be + operation: MODIFY + status: PASSED diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/events.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/events.yaml index 9e601058638c..2f139de98250 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/events.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/events.yaml @@ -1,25 +1,31 @@ summary: A collection of Events value: - - id: 'e092842f-c904-4b59-aac8-2544abeeef4b' - name: 'Update Task Schedule Passed' - _type: 'event' - created: '2020-02-17T16:23:18.327Z' - synced: '2020-02-17T16:23:18.388Z' - action: 'TASK_SCHEDULE_UPDATE_PASSED' - type: 'SYSTEM_CONFIG' - actor: - name: 'MantisTaskScheduler' + - id: 001909ce8cc3b519436197105426b18b5fc6ca179803c0c3702e9038107bec78 + stack: wps + synced: 2023-06-01T22:01:38.170Z + created: 2023-06-01T22:01:37.818Z + objects: + - ACCOUNT + type: PROVISIONING + technicalName: ACCOUNT_MODIFY_PASSED target: - name: 'Perform provisioning activity search delete synchronization' - stack: 'tpe' - trackingNumber: 'c6b98bc39ece48b080826d16c76b166c' - ipAddress: '207.189.160.158' - details: "null" + name: Colt.Spears + actor: + name: System + name: Modify Account Passed + action: ModifyAccount attributes: - sourceName: 'SailPoint' - objects: - - 'TASK' - - 'SCHEDULE' - operation: 'UPDATE' - status: 'PASSED' - technicalName: 'TASK_SCHEDULE_UPDATE_PASSED' + accountUuid: "{2d1ec18a-84cc-4659-bf75-a1ce4d56a9c5}" + cloudAppName: Active Directory + appId: 5c71ff71195b4794a0b87e7cf36fb017 + sourceId: source + sourceName: Active Directory + accountName: CN=Colt Spears,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpoint,DC=com + interface: Identity Refresh + trackingNumber: 1f74901adbc0412d9fa51314195155be + operation: MODIFY + status: PASSED + pod: pod01-useast1 + org: org-name + _type: 'event' + _version: v2 diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/filterExists.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/filterExists.yaml new file mode 100644 index 000000000000..31eebbeb8d47 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/filterExists.yaml @@ -0,0 +1,210 @@ +summary: Filter with Exists +value: + - name: Cory Henry + firstName: Cory + lastName: Henry + displayName: Cory Henry + id: 026bb65ed1f54fcd89197ca986e9acac + email: Cory.Henry@sailpointdemo.com + created: '2024-04-04T21:32:46.844Z' + inactive: false + protected: false + status: UNREGISTERED + employeeNumber: '10090' + manager: + id: 903349b85746471a9a898722206109bb + name: Layla Hendricks + displayName: Layla Hendricks + isManager: true + identityProfile: + id: 00a2bc6244b34f4a88d985f035f2b68b + name: HR Global + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + attributes: + city: Austin + cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 + cloudLifecycleState: active + cloudStatus: UNREGISTERED + country: US + department: Revenue Operations + displayName: Cory Henry + email: Cory.Henry@sailpointdemo.com + firstname: Cory + identificationNumber: '10090' + identityState: ACTIVE + internalCloudStatus: UNREGISTERED + jobTitle: 'Manager, System Operations' + lastname: Henry + location: AMS + uid: '10090' + visibleSegments: + - d75ae486-044b-4eba-8113-0cdacb5341df + - 8ea4e957-f2f1-4cba-b202-54cc702528d1 + disabled: false + locked: false + accounts: + - id: a02142f41ad1407884da04a7bfa586d4 + name: Cory Henry + accountId: '10090' + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:32:46.844Z' + supportsPasswordChange: false + - id: f30019e125c74684acee7da3f1643d2a + name: $LUJ300-P3QNVHE6R7FB + accountId: 'CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: true + passwordLastSet: '2024-04-04T21:33:34.488Z' + entitlementAttributes: + memberOf: + - 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + created: '2024-04-04T21:37:03.481Z' + supportsPasswordChange: true + - id: 7fe340119c5d4b00a9b85d55b18a6416 + name: Cory Henry + accountId: Cory Henry + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:37:03.536Z' + supportsPasswordChange: true + accountAttributes: {} + accountCount: 2 + apps: + - id: '20003' + name: Active Directory + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: f30019e125c74684acee7da3f1643d2a + accountId: 'CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20013' + name: AD test + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: f30019e125c74684acee7da3f1643d2a + accountId: 'CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20014' + name: Test AD + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: f30019e125c74684acee7da3f1643d2a + accountId: 'CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5092' + name: Accounting + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: f30019e125c74684acee7da3f1643d2a + accountId: 'CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5822114389092541705' + name: IdentityNow app + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + account: + id: 7fe340119c5d4b00a9b85d55b18a6416 + accountId: Cory Henry + appCount: 5 + access: + - id: ad7025c956734455b28fa35e315e77fe + name: Benefits Common Access + displayName: Benefits Common Access + type: ROLE + description: Testing AD provisioning with birthright access + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 322c6bce405a495a8e841a014b7d8410 + name: tina.smith + displayName: tina.smith + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 7e277d102c874560becc464cdfe33a86 + name: Benefits Employees + displayName: Benefits Employees + type: ACCESS_PROFILE + description: Access for Benefits Employees. Distribution group and File share access. + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 4919721c3c1a4ca484469b85f0fd9ba1 + name: Benefits + displayName: Benefits + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + accessCount: 3 + accessProfileCount: 1 + entitlementCount: 1 + roleCount: 1 + modified: '2024-12-13T02:49:19.214Z' + visibleSegments: + - All Employees + - Austin Employees + visibleSegmentCount: 2 + tagCount: 0 + pod: pod01-useast1 + org: org-name + synced: '2024-12-13T06:10:29.734Z' + _type: identity + type: identity + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/filterRange.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/filterRange.yaml new file mode 100644 index 000000000000..b4666d208981 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/filterRange.yaml @@ -0,0 +1,312 @@ +summary: Filter with Range +value: + - name: Mia Garcia + firstName: Mia + lastName: Garcia + displayName: Mia Garcia + id: 88e405b1a3b8439daf2efc8f4ff0a98b + email: Mia.Garcia@sailpointdemo.com + created: '2024-04-04T21:33:05.522Z' + inactive: false + protected: false + status: UNREGISTERED + employeeNumber: '10142' + manager: + id: 624db52c764f410baca2b192caad8e58 + name: Ethan Johnson + displayName: Ethan Johnson + isManager: true + identityProfile: + id: 00a2bc6244b34f4a88d985f035f2b68b + name: HR Global + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + attributes: + city: London + cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 + cloudLifecycleState: active + cloudStatus: UNREGISTERED + country: GB + department: EMEA Sales + displayName: Mia Garcia + email: Mia.Garcia@sailpointdemo.com + firstname: Mia + identificationNumber: '10142' + identityState: ACTIVE + internalCloudStatus: UNREGISTERED + jobTitle: 'Regional Director, EMEA Sales' + lastname: Garcia + location: EMEA + uid: '10142' + visibleSegments: + - d75ae486-044b-4eba-8113-0cdacb5341df + disabled: false + locked: false + accounts: + - id: 9021760f10b64f42b7ebfb78085ccaff + name: Mia Garcia + accountId: '10142' + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:33:05.522Z' + supportsPasswordChange: false + - id: f3ef91f3c2874e79981f2d97297660ee + name: $DUJ300-H5LFRVRDLKKM + accountId: 'CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: true + passwordLastSet: '2024-04-04T21:33:25.979Z' + entitlementAttributes: + memberOf: + - >- + CN=Salesforce + Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - 'CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - >- + CN=Salesforce opportunity + management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + created: '2024-04-04T21:36:54.974Z' + supportsPasswordChange: true + - id: c379279cc5b9450cbb274aad31486510 + name: Mia Garcia + accountId: Mia Garcia + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:36:55.027Z' + supportsPasswordChange: true + accountAttributes: {} + accountCount: 2 + apps: + - id: '20003' + name: Active Directory + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: f3ef91f3c2874e79981f2d97297660ee + accountId: 'CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20013' + name: AD test + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: f3ef91f3c2874e79981f2d97297660ee + accountId: 'CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20014' + name: Test AD + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: f3ef91f3c2874e79981f2d97297660ee + accountId: 'CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5092' + name: Accounting + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: f3ef91f3c2874e79981f2d97297660ee + accountId: 'CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5822114389092541705' + name: IdentityNow app + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + account: + id: c379279cc5b9450cbb274aad31486510 + accountId: Mia Garcia + appCount: 5 + access: + - id: 7e277d102c874560becc464cdfe33a86 + name: Benefits Employees + displayName: Benefits Employees + type: ACCESS_PROFILE + description: Access for Benefits Employees. Distribution group and File share access. + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 468171f0af874adebb58d3718519bd56 + name: SalesCommonAccess + displayName: SalesCommonAccess + type: ACCESS_PROFILE + description: Grants basic access for everyone in the sale department + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: ad7025c956734455b28fa35e315e77fe + name: Benefits Common Access + displayName: Benefits Common Access + type: ROLE + description: Testing AD provisioning with birthright access + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 322c6bce405a495a8e841a014b7d8410 + name: tina.smith + displayName: tina.smith + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: a8819cb0445541438fe08dd38f311b3c + name: SalesGlobal + displayName: SalesGlobal + type: ROLE + description: All Sales people in the company + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 29b6ee3f91484d159b1ceac3109af151 + name: se.admin + displayName: se.admin + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 4919721c3c1a4ca484469b85f0fd9ba1 + name: Benefits + displayName: Benefits + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 4bf8f57887874e9c83ae3a662bf8988c + name: Sales-Folder + displayName: Sales-Folder + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: 'CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: f1bea520cace4489805d26de3463262d + name: Salesforce Access + displayName: Salesforce Access + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: >- + CN=Salesforce + Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 98a76b26b7884f3e8d115991cebc09b2 + name: Salesforce opportunity management + displayName: Salesforce opportunity management + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: >- + CN=Salesforce opportunity + management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + accessCount: 8 + accessProfileCount: 2 + entitlementCount: 4 + roleCount: 2 + modified: '2024-12-13T02:49:35.220Z' + visibleSegments: + - All Employees + visibleSegmentCount: 1 + tagCount: 0 + pod: pod01-useast1 + org: org-name + synced: '2024-12-13T06:25:44.222Z' + _type: identity + type: identity + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/filterTerms.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/filterTerms.yaml new file mode 100644 index 000000000000..fce69d86e921 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/filterTerms.yaml @@ -0,0 +1,208 @@ +summary: Filter with Terms +value: + - name: Oliver Davies + firstName: Oliver + lastName: Davies + displayName: Oliver Davies + id: b173815fef574b74a283f39e6634c215 + email: Oliver.Davies@sailpointdemo.com + created: '2024-04-04T21:32:27.473Z' + inactive: false + protected: false + status: UNREGISTERED + employeeNumber: '10029' + manager: + id: b8c8e021a4104eda91b80bfac6a99b47 + name: Jackson Brooks + displayName: Jackson Brooks + isManager: true + identityProfile: + id: 00a2bc6244b34f4a88d985f035f2b68b + name: HR Global + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + attributes: + city: London + cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 + cloudLifecycleState: active + cloudStatus: UNREGISTERED + country: GB + department: Customer Support + displayName: Oliver Davies + email: Oliver.Davies@sailpointdemo.com + firstname: Oliver + identificationNumber: '10029' + identityState: ACTIVE + internalCloudStatus: UNREGISTERED + jobTitle: Call Center + lastname: Davies + location: EMEA + uid: '10029' + visibleSegments: + - d75ae486-044b-4eba-8113-0cdacb5341df + disabled: false + locked: false + accounts: + - id: c8cacc7080254b2781f56e0ded6c8dea + name: $GRJ300-AQD2M7N9L7NT + accountId: 'CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: true + passwordLastSet: '2024-04-04T21:30:25.205Z' + entitlementAttributes: + memberOf: + - 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + created: '2024-04-04T21:33:54.332Z' + supportsPasswordChange: true + - id: cd7f58b2290c43909320ff89427b57a1 + name: Oliver Davies + accountId: '10029' + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:32:27.473Z' + supportsPasswordChange: false + - id: a1ee6cd948754371a98105a5a6dd067d + name: Oliver Davies + accountId: Oliver Davies + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:33:54.377Z' + supportsPasswordChange: true + accountAttributes: {} + accountCount: 2 + apps: + - id: '20003' + name: Active Directory + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: c8cacc7080254b2781f56e0ded6c8dea + accountId: 'CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20013' + name: AD test + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: c8cacc7080254b2781f56e0ded6c8dea + accountId: 'CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20014' + name: Test AD + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: c8cacc7080254b2781f56e0ded6c8dea + accountId: 'CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5092' + name: Accounting + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: c8cacc7080254b2781f56e0ded6c8dea + accountId: 'CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5822114389092541705' + name: IdentityNow app + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + account: + id: a1ee6cd948754371a98105a5a6dd067d + accountId: Oliver Davies + appCount: 5 + access: + - id: ad7025c956734455b28fa35e315e77fe + name: Benefits Common Access + displayName: Benefits Common Access + type: ROLE + description: Testing AD provisioning with birthright access + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 322c6bce405a495a8e841a014b7d8410 + name: tina.smith + displayName: tina.smith + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 7e277d102c874560becc464cdfe33a86 + name: Benefits Employees + displayName: Benefits Employees + type: ACCESS_PROFILE + description: Access for Benefits Employees. Distribution group and File share access. + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 4919721c3c1a4ca484469b85f0fd9ba1 + name: Benefits + displayName: Benefits + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + accessCount: 3 + accessProfileCount: 1 + entitlementCount: 1 + roleCount: 1 + modified: '2024-12-13T02:49:35.917Z' + visibleSegments: + - All Employees + visibleSegmentCount: 1 + tagCount: 0 + pod: pod01-useast1 + org: org-name + synced: '2024-12-13T06:28:14.763Z' + _type: identity + type: identity + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/identities.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/identities.yaml index 0176a54adbc2..28701997d007 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/identities.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/identities.yaml @@ -1,128 +1,324 @@ summary: A collection of Identities value: - - id: '2c9180865c45e7e3015c46c434a80622' - name: 'ad.admin' - _type: 'identity' - firstName: 'AD' - lastName: 'Admin' - displayName: 'AD Admin' - email: 'SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM' - created: '2018-08-22T19:54:54.302Z' - modified: '2018-08-22T19:54:54.302Z' - synced: '2018-08-22T19:54:54.302Z' - phone: '512-942-7578' + - id: 2c9180865c45e7e3015c46c434a80622 + name: Laura Peeters + firstName: Laura + lastName: Peeters + displayName: Laura Peeters + email: Laura.Peeters@sailpointdemo.com + created: 2024-04-04T21:36:00.385Z inactive: false protected: false - status: 'UNREGISTERED' - employeeNumber: 'O349804' - manager: null - isManager: false + status: ACTIVE + employeeNumber: "10673" + manager: + id: 88e405b1a3b8439daf2efc8f4ff0a98b + name: Mia Garcia + displayName: Mia Garcia + isManager: true identityProfile: - id: '2c918085605c8d0601606f357cb231e6' - name: 'E2E AD' + id: 00a2bc6244b34f4a88d985f035f2b68b + name: HR Global source: - id: '2c9180855c45b230015c46c19b9c0202' - name: 'EndToEnd-ADSource' + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global attributes: - uid: 'ad.admin' - firstname: 'AD' - cloudAuthoritativeSource: '2c9180855c45b230015c46c19b9c0202' - cloudStatus: 'UNREGISTERED' - iplanet-am-user-alias-list: null - displayName: 'AD Admin' - internalCloudStatus: 'UNREGISTERED' - workPhone: '512-942-7578' - email: 'SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM' - lastname: 'Admin' - processingState: null - processingDetails: null + city: Brussels + cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 + cloudLifecycleState: active + cloudStatus: ACTIVE + country: BE + department: EMEA Sales + displayName: Laura Peeters + email: Laura.Peeters@sailpointdemo.com + firstname: Laura + identificationNumber: "10673" + identityState: ACTIVE + internalCloudStatus: ACTIVE + jobTitle: Manager, Sales - Belgium + lastname: Peeters + location: EMEA + uid: "10673" + visibleSegments: + - d75ae486-044b-4eba-8113-0cdacb5341df + disabled: false + locked: false accounts: - - id: '2c9180865c45e7e3015c46c434a80623' - name: 'ad.admin' - accountId: 'CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local' - source: - id: '2c9180855c45b230015c46c19b9c0202' - name: 'EndToEnd-ADSource' - type: 'Active Directory - Direct' - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - passwordLastSet: '2018-08-22T19:54:54.302Z' - entitlementAttributes: - memberOf: - - 'CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local' - - 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' - created: '2018-08-22T19:54:54.302Z' - - id: '2c918083606d670c01606f35a30a0349' - name: 'ad.admin' - accountId: 'ad.admin' - source: - id: 'ff8081815c46b85b015c46b90c7c02a6' - name: 'IdentityNow' - type: 'IdentityNowConnector' - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - passwordLastSet: null - entitlementAttributes: - created: '2018-08-22T19:54:54.302Z' - accountCount: 2 + - id: 830396e8863442f1bce7b485612c8b51 + name: Laura Peeters + accountId: "10673" + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: 2024-04-04T21:36:00.385Z + supportsPasswordChange: false + - id: cd6797419f37492ba22ea991f9d6ba90 + name: $SEK300-N3K0K4HOPEB6 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: true + passwordLastSet: 2024-04-04T21:38:57.434Z + entitlementAttributes: + memberOf: + - CN=Salesforce + Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - CN=Salesforce opportunity + management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + created: 2024-04-04T21:42:26.787Z + supportsPasswordChange: true + - id: db145fd0ec6a4e0cbc3a24bbe0758c8f + name: Laura Peeters + accountId: "10681" + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: 2024-04-04T21:36:15.769Z + supportsPasswordChange: false + - id: 6b75898eec394b4c98a5c3d2d9ba311b + name: Laura Peeters + accountId: Laura Peeters + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: 2024-04-04T21:36:15.809Z + supportsPasswordChange: true + accountAttributes: {} + accountCount: 3 apps: - - id: '22751' - name: 'ADP Workforce Now' - source: - id: '2c9180855c45b230015c46e2f6a8026a' - name: 'Corporate Active Directory' - account: - id: '2c9180865c45efa4015c470be0de1606' - accountId: 'CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - appCount: 1 + - id: "20003" + name: Active Directory + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - id: "20013" + name: AD test + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - id: "20014" + name: Test AD + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - id: "5092" + name: Accounting + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - id: "5822114389092541705" + name: IdentityNow app + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + account: + id: 6b75898eec394b4c98a5c3d2d9ba311b + accountId: Laura Peeters + appCount: 5 access: - - id: '2c918083634bc6cb01639808d40270ba' - name: 'test [AccessProfile-1527264105448]' - displayName: 'test' - type: 'ACCESS_PROFILE' - description: 'test' - source: - id: '2c9180855c45b230015c46c19b9c0202' - name: 'EndToEnd-ADSource' - owner: - id: '2c9180865c45e7e3015c46c434a80622' - name: 'ad.admin' - displayName: 'AD Admin' - - id: '2c9180865c45e7e3015c46c457c50755' - name: 'Administrators' - displayName: 'Administrators' - type: 'ENTITLEMENT' - description: null - source: - id: '2c9180855c45b230015c46c19b9c0202' - name: 'EndToEnd-ADSource' - privileged: false - attribute: 'memberOf' - value: 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' - standalone: false - - id: '2c9180865decdaa5015e06598b293108' - name: 'test [cloudRole-1503345085223]' - displayName: 'test' - type: 'ROLE' - description: 'test' - owner: - id: '2c9180865c45e7e3015c46c5030707a0' - name: 'will.albin' - displayName: 'Albin Will' - disabled: false - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 + - id: 4919721c3c1a4ca484469b85f0fd9ba1 + name: Benefits + displayName: Benefits + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 4bf8f57887874e9c83ae3a662bf8988c + name: Sales-Folder + displayName: Sales-Folder + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: f1bea520cace4489805d26de3463262d + name: Salesforce Access + displayName: Salesforce Access + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 98a76b26b7884f3e8d115991cebc09b2 + name: Salesforce opportunity management + displayName: Salesforce opportunity management + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: CN=Salesforce opportunity + management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 7e277d102c874560becc464cdfe33a86 + name: Benefits Employees + displayName: Benefits Employees + type: ACCESS_PROFILE + description: Access for Benefits Employees. Distribution group and File share access. + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 468171f0af874adebb58d3718519bd56 + name: SalesCommonAccess + displayName: SalesCommonAccess + type: ACCESS_PROFILE + description: Grants basic access for everyone in the sale department + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: ad7025c956734455b28fa35e315e77fe + name: Benefits Common Access + displayName: Benefits Common Access + type: ROLE + description: Testing AD provisioning with birthright access + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 322c6bce405a495a8e841a014b7d8410 + name: tina.smith + displayName: tina.smith + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: a8819cb0445541438fe08dd38f311b3c + name: SalesGlobal + displayName: SalesGlobal + type: ROLE + description: All Sales people in the company + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 29b6ee3f91484d159b1ceac3109af151 + name: se.admin + displayName: se.admin + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + accessCount: 8 + accessProfileCount: 2 + entitlementCount: 4 + roleCount: 2 + modified: 2025-01-17T03:17:17.895Z + visibleSegments: + - All Employees + visibleSegmentCount: 1 + tagCount: 2 tags: - - 'TAG_1' - - 'TAG_2' + - 'TAG_1' + - 'TAG_2' + pod: pod01-useast1 + org: org-name + synced: 2025-01-17T06:10:19.853Z + _type: identity + type: identity + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/identity.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/identity.yaml index b69269c10c47..91585a089616 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/identity.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/identity.yaml @@ -1,127 +1,318 @@ summary: Identity value: - id: '2c9180865c45e7e3015c46c434a80622' - name: 'ad.admin' - firstName: 'AD' - lastName: 'Admin' - displayName: 'AD Admin' - email: 'SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM' - created: '2018-08-22T19:54:54.302Z' - modified: '2018-08-22T19:54:54.302Z' - synced: '2018-08-22T19:54:54.302Z' - phone: '512-942-7578' + id: 2c9180865c45e7e3015c46c434a80622 + name: Laura Peeters + firstName: Laura + lastName: Peeters + displayName: Laura Peeters + email: Laura.Peeters@sailpointdemo.com + created: 2024-04-04T21:36:00.385Z inactive: false protected: false - status: 'UNREGISTERED' - employeeNumber: 'O349804' - manager: null - isManager: false + status: ACTIVE + employeeNumber: "10673" + manager: + id: 88e405b1a3b8439daf2efc8f4ff0a98b + name: Mia Garcia + displayName: Mia Garcia + isManager: true identityProfile: - id: '2c918085605c8d0601606f357cb231e6' - name: 'E2E AD' + id: 00a2bc6244b34f4a88d985f035f2b68b + name: HR Global source: - id: '2c9180855c45b230015c46c19b9c0202' - name: 'EndToEnd-ADSource' + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global attributes: - uid: 'ad.admin' - firstname: 'AD' - cloudAuthoritativeSource: '2c9180855c45b230015c46c19b9c0202' - cloudStatus: 'UNREGISTERED' - iplanet-am-user-alias-list: null - displayName: 'AD Admin' - internalCloudStatus: 'UNREGISTERED' - workPhone: '512-942-7578' - email: 'SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM' - lastname: 'Admin' - processingState: null - processingDetails: null + city: Brussels + cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 + cloudLifecycleState: active + cloudStatus: UNREGISTERED + country: BE + department: EMEA Sales + displayName: Laura Peeters + email: Laura.Peeters@sailpointdemo.com + firstname: Laura + identificationNumber: "10673" + identityState: ACTIVE + internalCloudStatus: UNREGISTERED + jobTitle: Manager, Sales - Belgium + lastname: Peeters + location: EMEA + uid: "10673" + visibleSegments: + - d75ae486-044b-4eba-8113-0cdacb5341df + disabled: false + locked: false accounts: - - id: '2c9180865c45e7e3015c46c434a80623' - name: 'ad.admin' - accountId: 'CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local' - source: - id: '2c9180855c45b230015c46c19b9c0202' - name: 'EndToEnd-ADSource' - type: 'Active Directory - Direct' - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - passwordLastSet: '2018-08-22T19:54:54.302Z' - entitlementAttributes: - memberOf: - - 'CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local' - - 'CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local' - - 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' - created: '2018-08-22T19:54:54.302Z' - - id: '2c918083606d670c01606f35a30a0349' - name: 'ad.admin' - accountId: 'ad.admin' - source: - id: 'ff8081815c46b85b015c46b90c7c02a6' - name: 'IdentityNow' - type: 'IdentityNowConnector' - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - passwordLastSet: null - entitlementAttributes: - created: '2018-08-22T19:54:54.302Z' - accountCount: 2 + - id: 830396e8863442f1bce7b485612c8b51 + name: Laura Peeters + accountId: "10673" + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: 2024-04-04T21:36:00.385Z + supportsPasswordChange: false + - id: cd6797419f37492ba22ea991f9d6ba90 + name: $SEK300-N3K0K4HOPEB6 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: true + passwordLastSet: 2024-04-04T21:38:57.434Z + entitlementAttributes: + memberOf: + - CN=Salesforce + Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - CN=Salesforce opportunity + management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + created: 2024-04-04T21:42:26.787Z + supportsPasswordChange: true + - id: db145fd0ec6a4e0cbc3a24bbe0758c8f + name: Laura Peeters + accountId: "10681" + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: 2024-04-04T21:36:15.769Z + supportsPasswordChange: false + - id: 6b75898eec394b4c98a5c3d2d9ba311b + name: Laura Peeters + accountId: Laura Peeters + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: 2024-04-04T21:36:15.809Z + supportsPasswordChange: true + accountAttributes: {} + accountCount: 3 apps: - - id: '22751' - name: 'ADP Workforce Now' - source: - id: '2c9180855c45b230015c46e2f6a8026a' - name: 'Corporate Active Directory' - account: - id: '2c9180865c45efa4015c470be0de1606' - accountId: 'CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - appCount: 1 + - id: "20003" + name: Active Directory + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - id: "20013" + name: AD test + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - id: "20014" + name: Test AD + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - id: "5092" + name: Accounting + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - id: "5822114389092541705" + name: IdentityNow app + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + account: + id: 6b75898eec394b4c98a5c3d2d9ba311b + accountId: Laura Peeters + appCount: 5 access: - - id: '2c918083634bc6cb01639808d40270ba' - name: 'test [AccessProfile-1527264105448]' - displayName: 'test' - type: 'ACCESS_PROFILE' - description: 'test' - source: - id: '2c9180855c45b230015c46c19b9c0202' - name: 'EndToEnd-ADSource' - owner: - id: '2c9180865c45e7e3015c46c434a80622' - name: 'ad.admin' - displayName: 'AD Admin' - - id: '2c9180865c45e7e3015c46c457c50755' - name: 'Administrators' - displayName: 'Administrators' - type: 'ENTITLEMENT' - description: null - source: - id: '2c9180855c45b230015c46c19b9c0202' - name: 'EndToEnd-ADSource' - privileged: false - attribute: 'memberOf' - value: 'CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local' - standalone: false - - id: '2c9180865decdaa5015e06598b293108' - name: 'test [cloudRole-1503345085223]' - displayName: 'test' - type: 'ROLE' - description: 'test' - owner: - id: '2c9180865c45e7e3015c46c5030707a0' - name: 'will.albin' - displayName: 'Albin Will' - disabled: false - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 + - id: 4919721c3c1a4ca484469b85f0fd9ba1 + name: Benefits + displayName: Benefits + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 4bf8f57887874e9c83ae3a662bf8988c + name: Sales-Folder + displayName: Sales-Folder + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: f1bea520cace4489805d26de3463262d + name: Salesforce Access + displayName: Salesforce Access + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 98a76b26b7884f3e8d115991cebc09b2 + name: Salesforce opportunity management + displayName: Salesforce opportunity management + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: CN=Salesforce opportunity + management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 7e277d102c874560becc464cdfe33a86 + name: Benefits Employees + displayName: Benefits Employees + type: ACCESS_PROFILE + description: Access for Benefits Employees. Distribution group and File share access. + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 468171f0af874adebb58d3718519bd56 + name: SalesCommonAccess + displayName: SalesCommonAccess + type: ACCESS_PROFILE + description: Grants basic access for everyone in the sale department + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: ad7025c956734455b28fa35e315e77fe + name: Benefits Common Access + displayName: Benefits Common Access + type: ROLE + description: Testing AD provisioning with birthright access + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 322c6bce405a495a8e841a014b7d8410 + name: tina.smith + displayName: tina.smith + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: a8819cb0445541438fe08dd38f311b3c + name: SalesGlobal + displayName: SalesGlobal + type: ROLE + description: All Sales people in the company + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 29b6ee3f91484d159b1ceac3109af151 + name: se.admin + displayName: se.admin + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + accessCount: 8 + accessProfileCount: 2 + entitlementCount: 4 + roleCount: 2 + modified: 2025-01-17T03:17:17.895Z + visibleSegments: + - All Employees + visibleSegmentCount: 1 + tagCount: 2 tags: - - 'TAG_1' - - 'TAG_2' + - 'TAG_1' + - 'TAG_2' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/queryFields.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/queryFields.yaml new file mode 100644 index 000000000000..5ae389abd14f --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/queryFields.yaml @@ -0,0 +1,198 @@ +summary: 'Query with Fields' +value: + - name: John Doe + firstName: John + lastName: Doe + displayName: John Doe + id: 655f6741762547ec937893f27eab0cec + email: John.Doe@sailpointdemo.com + created: '2025-01-03T22:36:20.025Z' + inactive: false + protected: false + status: UNREGISTERED + isManager: false + identityProfile: + id: 63e42f96f2fc4b8ba544654eba6068cf + name: Contractors + source: + id: b33c36dbaf974200b4d91f846abc30a5 + name: Contractors + attributes: + cloudAuthoritativeSource: b33c36dbaf974200b4d91f846abc30a5 + cloudLifecycleState: active + cloudStatus: UNREGISTERED + displayName: John Doe + email: John.Doe@sailpointdemo.com + endDate: '2199-01-01T00:00:00.000Z' + firstname: John + identityState: ACTIVE + internalCloudStatus: UNREGISTERED + lastname: Doe + startDate: '2199-01-01T00:00:00.000Z' + uid: John Doe + visibleSegments: + - d75ae486-044b-4eba-8113-0cdacb5341df + disabled: false + locked: false + accounts: + - id: 6f9cce655ddd40ca86a8faab8d5d52ec + name: John Doe + accountId: ac10e3a8-942a-1409-8194-2e4fe3090003 + source: + id: b33c36dbaf974200b4d91f846abc30a5 + name: Contractors + type: Non-Employee + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2025-01-03T22:36:20.045Z' + supportsPasswordChange: false + - id: 9e29df88d4c5449ea790b4c24135b85c + name: $FHK300-LAAKDKHU50K3 + accountId: 'CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: true + entitlementAttributes: + memberOf: + - 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + created: '2025-01-03T22:36:36.866Z' + supportsPasswordChange: true + - id: 74e0cd14200943ff92b4f11fa3596eba + name: John Doe + accountId: John Doe + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2025-01-03T22:36:20.076Z' + supportsPasswordChange: true + accountAttributes: {} + accountCount: 2 + apps: + - id: '20003' + name: Active Directory + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: 9e29df88d4c5449ea790b4c24135b85c + accountId: 'CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20013' + name: AD test + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: 9e29df88d4c5449ea790b4c24135b85c + accountId: 'CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20014' + name: Test AD + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: 9e29df88d4c5449ea790b4c24135b85c + accountId: 'CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5092' + name: Accounting + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: 9e29df88d4c5449ea790b4c24135b85c + accountId: 'CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5822114389092541705' + name: IdentityNow app + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + account: + id: 74e0cd14200943ff92b4f11fa3596eba + accountId: John Doe + appCount: 5 + access: + - id: 4919721c3c1a4ca484469b85f0fd9ba1 + name: Benefits + displayName: Benefits + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 7e277d102c874560becc464cdfe33a86 + name: Benefits Employees + displayName: Benefits Employees + type: ACCESS_PROFILE + description: Access for Benefits Employees. Distribution group and File share access. + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: ad7025c956734455b28fa35e315e77fe + name: Benefits Common Access + displayName: Benefits Common Access + type: ROLE + description: Testing AD provisioning with birthright access + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 322c6bce405a495a8e841a014b7d8410 + name: tina.smith + displayName: tina.smith + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + accessCount: 3 + accessProfileCount: 1 + entitlementCount: 1 + roleCount: 1 + modified: '2025-01-03T22:36:37.599Z' + visibleSegments: + - All Employees + visibleSegmentCount: 1 + tagCount: 0 + pod: pod01-useast1 + org: org-name + synced: '2025-01-03T22:37:04.452Z' + _type: identity + type: identity + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/queryInnerHit.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/queryInnerHit.yaml new file mode 100644 index 000000000000..f961c3a185d1 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/queryInnerHit.yaml @@ -0,0 +1,47 @@ +summary: 'Query with InnerHit' +value: + - requestCommentsRequired: false + schema: group + cloudEligible: false + displayName: Benefits + standalone: false + source: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + type: ENTITLEMENT + enabled: false + privileged: false + name: Benefits + disabled: false + id: 4919721c3c1a4ca484469b85f0fd9ba1 + requestable: false + attribute: memberOf + value: 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + cloudGoverned: false + _type: access + _originalType: identity + _version: v2 + - requestCommentsRequired: false + owner: + displayName: Jerry.Bennett + name: Jerry.Bennett + id: 278f8a1859df48d2a0adb204257b26a2 + cloudEligible: false + displayName: Benefits Employees + standalone: false + description: Access for Benefits Employees. Distribution group and File share access. + source: + name: Active Directory + id: 5c71ff71195b4794a0b87e7cf36fb017 + revocable: false + type: ACCESS_PROFILE + enabled: false + privileged: false + name: Benefits Employees + disabled: false + id: 7e277d102c874560becc464cdfe33a86 + requestable: false + cloudGoverned: false + _type: access + _originalType: identity + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/queryTimeZone.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/queryTimeZone.yaml new file mode 100644 index 000000000000..d16398ec9de5 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/queryTimeZone.yaml @@ -0,0 +1,326 @@ +summary: 'Query with TimeZone' +value: + - name: Laura Peeters + firstName: Laura + lastName: Peeters + displayName: Laura Peeters + id: 0011cac38db341738af1f2ce7bb3aede + email: Laura.Peeters@sailpointdemo.com + created: '2024-04-04T21:36:00.385Z' + inactive: false + protected: false + status: UNREGISTERED + employeeNumber: '10673' + manager: + id: 88e405b1a3b8439daf2efc8f4ff0a98b + name: Mia Garcia + displayName: Mia Garcia + isManager: true + identityProfile: + id: 00a2bc6244b34f4a88d985f035f2b68b + name: HR Global + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + attributes: + city: Brussels + cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 + cloudLifecycleState: active + cloudStatus: UNREGISTERED + country: BE + department: EMEA Sales + displayName: Laura Peeters + email: Laura.Peeters@sailpointdemo.com + firstname: Laura + identificationNumber: '10673' + identityState: ACTIVE + internalCloudStatus: UNREGISTERED + jobTitle: 'Manager, Sales - Belgium' + lastname: Peeters + location: EMEA + uid: '10673' + visibleSegments: + - d75ae486-044b-4eba-8113-0cdacb5341df + disabled: false + locked: false + accounts: + - id: 830396e8863442f1bce7b485612c8b51 + name: Laura Peeters + accountId: '10673' + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:36:00.385Z' + supportsPasswordChange: false + - id: cd6797419f37492ba22ea991f9d6ba90 + name: $SEK300-N3K0K4HOPEB6 + accountId: 'CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + type: Active Directory - Direct + disabled: false + locked: false + privileged: false + manuallyCorrelated: true + passwordLastSet: '2024-04-04T21:38:57.434Z' + entitlementAttributes: + memberOf: + - >- + CN=Salesforce + Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + - 'CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - >- + CN=Salesforce opportunity + management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + created: '2024-04-04T21:42:26.787Z' + supportsPasswordChange: true + - id: db145fd0ec6a4e0cbc3a24bbe0758c8f + name: Laura Peeters + accountId: '10681' + source: + id: 524f8d986f9b4192865269516d169eb0 + name: HR Global + type: DelimitedFile + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:36:15.769Z' + supportsPasswordChange: false + - id: 6b75898eec394b4c98a5c3d2d9ba311b + name: Laura Peeters + accountId: Laura Peeters + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + type: IdentityNowConnector + disabled: false + locked: false + privileged: false + manuallyCorrelated: false + entitlementAttributes: {} + created: '2024-04-04T21:36:15.809Z' + supportsPasswordChange: true + accountAttributes: {} + accountCount: 3 + apps: + - id: '20003' + name: Active Directory + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: 'CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20013' + name: AD test + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: 'CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '20014' + name: Test AD + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: 'CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5092' + name: Accounting + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + account: + id: cd6797419f37492ba22ea991f9d6ba90 + accountId: 'CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + - id: '5822114389092541705' + name: IdentityNow app + source: + id: af4686d6482841ac96d793901372ad9b + name: IdentityNow + account: + id: 6b75898eec394b4c98a5c3d2d9ba311b + accountId: Laura Peeters + appCount: 5 + access: + - id: 4919721c3c1a4ca484469b85f0fd9ba1 + name: Benefits + displayName: Benefits + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: 'CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 4bf8f57887874e9c83ae3a662bf8988c + name: Sales-Folder + displayName: Sales-Folder + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: 'CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: f1bea520cace4489805d26de3463262d + name: Salesforce Access + displayName: Salesforce Access + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: >- + CN=Salesforce + Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 98a76b26b7884f3e8d115991cebc09b2 + name: Salesforce opportunity management + displayName: Salesforce opportunity management + type: ENTITLEMENT + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + disabled: false + privileged: false + attribute: memberOf + value: >- + CN=Salesforce opportunity + management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + standalone: false + cloudEligible: false + cloudGoverned: false + schema: group + - id: 7e277d102c874560becc464cdfe33a86 + name: Benefits Employees + displayName: Benefits Employees + type: ACCESS_PROFILE + description: Access for Benefits Employees. Distribution group and File share access. + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: 468171f0af874adebb58d3718519bd56 + name: SalesCommonAccess + displayName: SalesCommonAccess + type: ACCESS_PROFILE + description: Grants basic access for everyone in the sale department + enabled: false + requestable: false + requestCommentsRequired: false + source: + id: 5c71ff71195b4794a0b87e7cf36fb017 + name: Active Directory + owner: + id: 278f8a1859df48d2a0adb204257b26a2 + name: Jerry.Bennett + displayName: Jerry.Bennett + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: ad7025c956734455b28fa35e315e77fe + name: Benefits Common Access + displayName: Benefits Common Access + type: ROLE + description: Testing AD provisioning with birthright access + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 322c6bce405a495a8e841a014b7d8410 + name: tina.smith + displayName: tina.smith + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + - id: a8819cb0445541438fe08dd38f311b3c + name: SalesGlobal + displayName: SalesGlobal + type: ROLE + description: All Sales people in the company + enabled: false + requestable: false + requestCommentsRequired: false + owner: + id: 29b6ee3f91484d159b1ceac3109af151 + name: se.admin + displayName: se.admin + disabled: false + privileged: false + standalone: false + revocable: false + cloudEligible: false + cloudGoverned: false + accessCount: 8 + accessProfileCount: 2 + entitlementCount: 4 + roleCount: 2 + modified: '2024-12-13T02:49:18.104Z' + visibleSegments: + - All Employees + visibleSegmentCount: 1 + tagCount: 0 + pod: pod01-useast1 + org: org-name + synced: '2024-12-13T06:10:14.229Z' + _type: identity + type: identity + _version: v2 diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/role.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/role.yaml index 448d667fb083..645f59e92257 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/role.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/role.yaml @@ -1,35 +1,23 @@ summary: Role value: id: '2c91808c6faadea6016fb4f2bc69077b' - name: 'IT Role' - description: 'IT role' - created: '2020-01-17T19:20:15.040Z' - modified: null - synced: '2020-02-18T05:30:20.145Z' + accessProfileCount: 1 + accessProfiles: + - id: 468171f0af874adebb58d3718519bd56 + name: SalesCommonAccess + created: 2023-06-01T22:00:55.311Z + description: All Sales people in the company + dimensional: false enabled: true - requestable: false - requestCommentsRequired: false + modified: 2023-06-01T22:00:55.432Z + name: SalesGlobal owner: - id: '2c9180a46faadee4016fb4e018c20639' - name: 'Cloud Support' - type: 'IDENTITY' - email: 'thomas.edison@acme-solar.com' - accessProfiles: - - id: '2c91809c6faade77016fb4f0b63407ae' - name: 'Admin Access' - accessProfileCount: 1 - segments: - - id: '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' - name: 'segment-xyz' - description: 'This segment represents xyz' - segmentCount: 1 - entitlements: - - id: '2c91809c6faade77016fb4f0b63407ae' - name: 'Admin Access' - description: 'Access to everything' - privileged: true - hasPermissions: true - entitlementCount: 1 + email: admin@sailpointdemo.com + id: c18630c4811c4030810afb3a14f388cf + name: admin + type: IDENTITY + requestCommentsRequired: false + requestable: true tags: - - 'TAG_1' - - 'TAG_2' + - 'TAG_1' + - 'TAG_2' diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/roles.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/roles.yaml index 8035b2237617..8d0f7b7d6227 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/roles.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/roles.yaml @@ -1,24 +1,28 @@ summary: A collection of Roles value: - id: '2c91808c6faadea6016fb4f2bc69077b' - name: 'IT Role' - _type: 'role' - description: 'IT role' - created: '2020-01-17T19:20:15.040Z' - modified: null - synced: '2020-02-18T05:30:20.145Z' + accessProfileCount: 1 + accessProfiles: + - id: 468171f0af874adebb58d3718519bd56 + name: SalesCommonAccess + created: 2023-06-01T22:00:55.311Z + description: All Sales people in the company + dimensional: false enabled: true - requestable: false - requestCommentsRequired: false + modified: 2023-06-01T22:00:55.432Z + name: SalesGlobal owner: - id: '2c9180a46faadee4016fb4e018c20639' - name: 'Cloud Support' - type: 'IDENTITY' - email: 'thomas.edison@acme-solar.com' - accessProfiles: - - id: '2c91809c6faade77016fb4f0b63407ae' - name: 'Admin Access' - accessProfileCount: 1 + email: admin@sailpointdemo.com + id: c18630c4811c4030810afb3a14f388cf + name: admin + type: IDENTITY + requestCommentsRequired: false + requestable: true tags: - - 'TAG_1' - - 'TAG_2' + - 'TAG_1' + - 'TAG_2' + pod: pod01-useast1 + org: org-name + _type: role + type: role + _version: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/typeAheadQuery.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/typeAheadQuery.yaml new file mode 100644 index 000000000000..06a486f44783 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/typeAheadQuery.yaml @@ -0,0 +1,26 @@ +summary: 'TypeAhead Query' +value: + - Ethan Johnson + - Henry Jones + - Joan.Wells + - Joanna Gonzales + - Joe Cook + - Joe.Myers + - Johan Jacobs + - John Doe + - John Roberts + - John Smith + - John.Jarndyce + - John.Smithee + - John.Williams + - Johnny.Elliott + - Jonathan.West + - Jordan Wilson + - Jordan.Sullivan + - Jose.Reed + - Joao Carvalho + - Kamaria Jones + - Lisa Jones + - Mia Johnson + - Michael Johnson + - Scott Johnson diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/typeAheadQueryNestedType.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/typeAheadQueryNestedType.yaml new file mode 100644 index 000000000000..76090a29440e --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/typeAheadQueryNestedType.yaml @@ -0,0 +1,7 @@ +summary: TypeAhead Query with NestedType +value: + - Active Directory + - PRISM + - ServiceNow + - TRAKK-WS + - AWS \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/examples/filter-exists.yaml b/static/api-specs/idn/v3/schemas/search/examples/filter-exists.yaml index 2bf96d2874f1..2d229dee537a 100644 --- a/static/api-specs/idn/v3/schemas/search/examples/filter-exists.yaml +++ b/static/api-specs/idn/v3/schemas/search/examples/filter-exists.yaml @@ -3,8 +3,8 @@ value: indices: - 'identities' query: - query: 'attributes.city:London' + query: 'attributes.city:Austin' filters: - attributes.cloudAuthoritativeSource: + attributes.personalEmail: type: 'EXISTS' exclude: true diff --git a/static/api-specs/idn/v3/schemas/search/examples/filter-range.yaml b/static/api-specs/idn/v3/schemas/search/examples/filter-range.yaml index cd9235a36986..5dc9f0042a7d 100644 --- a/static/api-specs/idn/v3/schemas/search/examples/filter-range.yaml +++ b/static/api-specs/idn/v3/schemas/search/examples/filter-range.yaml @@ -15,7 +15,7 @@ value: type: 'RANGE' range: lower: - value: '2019-12-01' + value: '2023-12-01' inclusive: true upper: - value: '2020-01-01' + value: '2025-01-01' diff --git a/static/api-specs/idn/v3/schemas/search/examples/filter-terms.yaml b/static/api-specs/idn/v3/schemas/search/examples/filter-terms.yaml index bf6ab1e19c62..b7ed410a78f0 100644 --- a/static/api-specs/idn/v3/schemas/search/examples/filter-terms.yaml +++ b/static/api-specs/idn/v3/schemas/search/examples/filter-terms.yaml @@ -11,7 +11,7 @@ value: - 'HR Employees' - 'Corporate Active Directory' exclude: true - protected: + isManager: type: 'TERMS' terms: - 'true' diff --git a/static/api-specs/idn/v3/schemas/search/examples/query-accessprofiles.yaml b/static/api-specs/idn/v3/schemas/search/examples/query-accessprofiles.yaml new file mode 100644 index 000000000000..b5e9dfb6b8fa --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/examples/query-accessprofiles.yaml @@ -0,0 +1,6 @@ +summary: Query for Access Profiles +value: + indices: + - accessprofiles + query: + query: 'requestable:true' diff --git a/static/api-specs/idn/v3/schemas/search/examples/query-accountactivities.yaml b/static/api-specs/idn/v3/schemas/search/examples/query-accountactivities.yaml new file mode 100644 index 000000000000..db4635c7c46b --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/examples/query-accountactivities.yaml @@ -0,0 +1,6 @@ +summary: Query for Acccount Activities +value: + indices: + - accountactivities + query: + query: 'sources:"Active Directory"' diff --git a/static/api-specs/idn/v3/schemas/search/examples/query-entitlements.yaml b/static/api-specs/idn/v3/schemas/search/examples/query-entitlements.yaml new file mode 100644 index 000000000000..f3f9918c8851 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/examples/query-entitlements.yaml @@ -0,0 +1,6 @@ +summary: Query for Entitlements +value: + indices: + - entitlements + query: + query: 'source.name:Finance' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/examples/query-events.yaml b/static/api-specs/idn/v3/schemas/search/examples/query-events.yaml new file mode 100644 index 000000000000..ee1c5709481f --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/examples/query-events.yaml @@ -0,0 +1,6 @@ +summary: Query for Events +value: + indices: + - events + query: + query: 'type:PROVISIONING' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/examples/query-identities.yaml b/static/api-specs/idn/v3/schemas/search/examples/query-identities.yaml new file mode 100644 index 000000000000..753a8fddc770 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/examples/query-identities.yaml @@ -0,0 +1,6 @@ +summary: Query for Identities +value: + indices: + - identities + query: + query: 'attributes.cloudLifecycleState:active' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/examples/query-innerHit.yaml b/static/api-specs/idn/v3/schemas/search/examples/query-innerHit.yaml index db10a46eba2c..c09e3e41d242 100644 --- a/static/api-specs/idn/v3/schemas/search/examples/query-innerHit.yaml +++ b/static/api-specs/idn/v3/schemas/search/examples/query-innerHit.yaml @@ -6,4 +6,4 @@ value: query: '"John Doe"' innerHit: type: 'access' - query: 'source.name:\"Active Directory\"' + query: 'source.name:"Active Directory"' diff --git a/static/api-specs/idn/v3/schemas/search/examples/query-roles.yaml b/static/api-specs/idn/v3/schemas/search/examples/query-roles.yaml new file mode 100644 index 000000000000..6a407b11dbe6 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/examples/query-roles.yaml @@ -0,0 +1,6 @@ +summary: Query for Roles +value: + indices: + - roles + query: + query: 'enabled:true' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/examples/typeAheadQuery-nestedType.yaml b/static/api-specs/idn/v3/schemas/search/examples/typeAheadQuery-nestedType.yaml index 3d43593d6558..2f2f404e3a6d 100644 --- a/static/api-specs/idn/v3/schemas/search/examples/typeAheadQuery-nestedType.yaml +++ b/static/api-specs/idn/v3/schemas/search/examples/typeAheadQuery-nestedType.yaml @@ -1,4 +1,4 @@ -summary: TypeAheadQuery with NestedType +summary: TypeAhead Query with NestedType value: indices: - 'identities' diff --git a/static/api-specs/idn/v3/schemas/search/examples/typeAheadQuery.yaml b/static/api-specs/idn/v3/schemas/search/examples/typeAheadQuery.yaml index e14a2c4bdcbb..c2cddedd5b8e 100644 --- a/static/api-specs/idn/v3/schemas/search/examples/typeAheadQuery.yaml +++ b/static/api-specs/idn/v3/schemas/search/examples/typeAheadQuery.yaml @@ -1,4 +1,4 @@ -summary: TypeAheadQuery +summary: TypeAhead Query value: indices: - 'identities' diff --git a/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml b/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml index f2e8b09f8bc5..730b4fb196de 100644 --- a/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml @@ -2,9 +2,8 @@ allOf: - $ref: "../base/DisplayReference.yaml" - type: object properties: - type: - $ref: "../../../DtoType.yaml" description: + description: Description of access item. type: string nullable: true example: null diff --git a/static/api-specs/idn/v3/schemas/search/model/access/AccessApps.yaml b/static/api-specs/idn/v3/schemas/search/model/access/AccessApps.yaml new file mode 100644 index 000000000000..72f743eb4604 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/access/AccessApps.yaml @@ -0,0 +1,36 @@ + type: object + properties: + id: + type: string + example: '2c91808568c529c60168cca6f90c1313' + description: The unique ID of the referenced object. + name: + type: string + description: Name of application + example: Travel and Expense + description: + description: Description of application. + type: string + example: Travel and Expense Application + owner: + 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: John Doe + email: + type: string + description: Owner's email. + example: john.doe@sailpoint.com \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileEntitlement.yaml b/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileEntitlement.yaml index b08846006d88..3e56a90a7b38 100644 --- a/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileEntitlement.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileEntitlement.yaml @@ -5,6 +5,10 @@ allOf: properties: source: $ref: "../base/Reference.yaml" + type: + type: string + description: Type of the access item. + example: ENTITLEMENT privileged: type: boolean example: false diff --git a/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileRole.yaml b/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileRole.yaml index 2866560fd44e..2a4bb2a21be0 100644 --- a/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileRole.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileRole.yaml @@ -3,6 +3,10 @@ allOf: - $ref: 'Access.yaml' - type : object properties: + type: + type: string + description: Type of the access item. + example: ROLE owner: $ref: '../base/DisplayReference.yaml' disabled: diff --git a/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileSummary.yaml b/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileSummary.yaml index d34c9449db18..30322c8ca93e 100644 --- a/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileSummary.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/access/AccessProfileSummary.yaml @@ -4,6 +4,10 @@ allOf: - $ref: "Access.yaml" - type: object properties: + type: + type: string + description: Type of the access item. + example: ACCESS_PROFILE source: $ref: "../base/Reference.yaml" owner: diff --git a/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml b/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml index 4e839c9ff46f..1f0731fd8fdb 100644 --- a/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml @@ -1,69 +1,67 @@ -allOf: - - $ref: "../base/Reference.yaml" - - type: object +type: object +properties: + description: + type: string + description: Access item's description. + example: "Admin access" + created: + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' + modified: + type: string + description: ISO-8601 date-time referring to the time when the object was last modified. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' + synced: + type: string + description: >- + ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. + + This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. + + There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:33.104Z' + enabled: + type: boolean + description: Indicates whether the access item is currently enabled. + default: false + example: true + requestable: + type: boolean + description: Indicates whether the access item can be requested. + default: true + example: true + requestCommentsRequired: + type: boolean + description: Indicates whether comments are required for requests to access the item. + default: false + example: false + owner: + type: object + description: Owner's identity. properties: - description: - type: string - description: Access item's description. - example: "The admin role" - created: + type: + type: string + description: Owner's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: 'date-time' - example: '2018-06-25T20:22:28.104Z' - modified: + description: Owner's identity ID. + example: 2c9180a46faadee4016fb4e018c20639 + name: type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: 'date-time' - example: '2018-06-25T20:22:28.104Z' - synced: + description: Owner's display name. + example: Support + email: type: string - description: >- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - nullable: true - format: 'date-time' - example: '2018-06-25T20:22:33.104Z' - enabled: - type: boolean - description: Indicates whether the access item is currently enabled. - default: false - example: true - requestable: - type: boolean - description: Indicates whether the access item can be requested. - default: true - example: true - requestCommentsRequired: - type: boolean - description: Indicates whether comments are required for requests to access the item. - default: false - example: false - owner: - 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 - email: - type: string - description: Owner's email. - example: cloud-support@sailpoint.com + description: Owner's email. + example: cloud-support@sailpoint.com diff --git a/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml index 8ad1217fbc70..d5d9eef47e46 100644 --- a/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml @@ -3,7 +3,7 @@ description: >- allOf: - $ref: '../BaseAccess.yaml' - type: object - required: ["id", "name", "_type"] + required: ["id", "name"] properties: id: type: string @@ -13,24 +13,6 @@ allOf: type: string description: Access profile's name. example: Cloud Eng - _type: - description: >- - Access profile's document type. - - This enum represents the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - account - - aggregation - - entitlement - - event - - identity - - role - example: accessprofile source: type: object description: Access profile's source. @@ -52,5 +34,21 @@ allOf: type: integer description: Number of entitlements. example: 5 + segments: + type: array + description: Segments with the access profile. + items: + $ref: '../../base/BaseSegment.yaml' + segmentCount: + type: integer + description: Number of segments with the access profile. + format: int32 + example: 1 tags: $ref: '../../base/Tags.yaml' + apps: + type: array + description: Applications with the access profile + items: + $ref: '../AccessApps.yaml' + diff --git a/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocuments.yaml b/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocuments.yaml new file mode 100644 index 000000000000..2387bab50d80 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocuments.yaml @@ -0,0 +1,4 @@ +type: object +allOf: + - $ref: 'AccessProfileDocument.yaml' + - $ref: '../../base/DocumentFields.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/account/ActivityIdentity.yaml b/static/api-specs/idn/v3/schemas/search/model/account/ActivityIdentity.yaml new file mode 100644 index 000000000000..1b4483cbfd5a --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/account/ActivityIdentity.yaml @@ -0,0 +1,8 @@ +allOf: +- $ref: '../base/Reference.yaml' +- type: object + properties: + type: + type: string + example: Identity + description: Type of object diff --git a/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml b/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml index b35e903e6025..09fabdc15109 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml @@ -45,3 +45,17 @@ allOf: nullable: true format: 'date-time' example: '2018-06-25T20:22:28.104Z' + supportsPasswordChange: + type: boolean + description: Indicates whether the account supports password change. + default: false + example: false + accountAttributes: + type: object + nullable: true + description: Map or dictionary of key/value pairs. + additionalProperties: true + example: + type: global + admin: true + trust_level: "4" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml index ae72acde3533..169f0561366d 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml @@ -1,83 +1,89 @@ description: AccountActivity -allOf: - - $ref: "../../base/BaseDocument.yaml" - - type: object - properties: - action: - type: string - description: Type of action performed in the activity. - externalDocs: - description: Learn more about account activity action types - url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data - example: Identity Refresh. - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: 'date-time' - example: '2018-06-25T20:22:28.104Z' - modified: - type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: 'date-time' - example: '2018-06-25T20:22:28.104Z' - stage: - type: string - description: Activity's current stage. - example: Completed - origin: - type: string - description: Activity's origin. - nullable: true - example: null - status: - type: string - description: Activity's current status. - example: Complete - requester: - $ref: "../AccountSource.yaml" - recipient: - $ref: "../AccountSource.yaml" - trackingNumber: - type: string - description: Account activity's tracking number. - example: 61aad0c9e8134eca89e76a35e0cabe3f - errors: - type: array - description: Errors provided by the source while completing account actions. - items: - type: string - nullable: true - example: null - warnings: - type: array - description: Warnings provided by the source while completing account actions. - items: - type: string - nullable: true - example: null - approvals: - type: array - description: Approvals performed on an item during activity. - items: - $ref: "Approval.yaml" - originalRequests: - type: array - description: Original actions that triggered all individual source actions related to the account action. - items: - $ref: "OriginalRequest.yaml" - expansionItems: - type: array - description: Controls that translated the attribute requests into actual provisioning actions on the source. - items: - $ref: "ExpansionItem.yaml" - accountRequests: - type: array - description: Account data for each individual source action triggered by the original requests. - items: - $ref: "AccountRequest.yaml" - sources: - type: string - description: Sources involved in the account activity. - example: "smartsheet-test, airtable-v4, IdentityNow" +type: object +properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + description: ID of account activity. + action: + type: string + description: Type of action performed in the activity. + externalDocs: + description: Learn more about account activity action types + url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data + example: Identity Refresh. + created: + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' + modified: + type: string + description: ISO-8601 date-time referring to the time when the object was last modified. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' + synced: + type: string + description: >- + ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. + + This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. + + There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. + example: '2018-06-25T20:22:28.104Z' + stage: + type: string + description: Activity's current stage. + example: Completed + status: + type: string + description: Activity's current status. + example: Complete + requester: + $ref: "../ActivityIdentity.yaml" + recipient: + $ref: "../ActivityIdentity.yaml" + trackingNumber: + type: string + description: Account activity's tracking number. + example: 61aad0c9e8134eca89e76a35e0cabe3f + errors: + type: array + description: Errors provided by the source while completing account actions. + items: + type: string + nullable: true + example: null + warnings: + type: array + description: Warnings provided by the source while completing account actions. + items: + type: string + nullable: true + example: null + approvals: + type: array + description: Approvals performed on an item during activity. + items: + $ref: "Approval.yaml" + originalRequests: + type: array + description: Original actions that triggered all individual source actions related to the account action. + items: + $ref: "OriginalRequest.yaml" + expansionItems: + type: array + description: Controls that translated the attribute requests into actual provisioning actions on the source. + items: + $ref: "ExpansionItem.yaml" + accountRequests: + type: array + description: Account data for each individual source action triggered by the original requests. + items: + $ref: "AccountRequest.yaml" + sources: + type: string + description: Sources involved in the account activity. + example: "smartsheet-test, airtable-v4, IdentityNow" diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocuments.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocuments.yaml new file mode 100644 index 000000000000..8ce465566c04 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocuments.yaml @@ -0,0 +1,4 @@ +type: object +allOf: + - $ref: 'AccountActivityDocument.yaml' + - $ref: '../../base/DocumentFields.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountRequest.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountRequest.yaml index 9ea0f8538a62..b9b5c0789312 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountRequest.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountRequest.yaml @@ -27,6 +27,7 @@ properties: [\n \"groups\"\n ],\n \"path\": [],\n \"message\": \"Unrecognized key(s) in object: 'groups'\"\n }\n] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)" + description: Error message. status: type: string description: The status of the account request @@ -35,5 +36,6 @@ properties: type: string nullable: true example: null + description: ID of associated ticket. source: $ref: "../AccountSource.yaml" diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/Approval.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/Approval.yaml index 20bc881472d4..10f93b108ce8 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/Approval.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/Approval.yaml @@ -4,17 +4,15 @@ properties: type: array items: $ref: "ApprovalComment.yaml" - created: - $ref: "../../base/DateTime.yaml" modified: $ref: "../../base/DateTime.yaml" owner: - $ref: "../AccountSource.yaml" + $ref: "../ActivityIdentity.yaml" result: type: string description: The result of the approval example: Finished - type: - type: string - nullable: true - example: null + attributeRequest: + $ref: "AttributeRequest.yaml" + source: + $ref: "../AccountSource.yaml" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml index 01d333fcdf4f..f2d582e9dee5 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml @@ -9,6 +9,11 @@ properties: description: Operation to perform on attribute. example: Add value: - type: string - description: Value of attribute. - example: "3203537556531076" + oneOf: + - type: string + example: "3203537556531076" + - type: array + items: + type: string + example: [ "3203537556531076", "1263537556831096"] + description: Value of attribute. \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/ExpansionItem.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/ExpansionItem.yaml index e0d8ec8afc48..15f505359bb9 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/ExpansionItem.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/ExpansionItem.yaml @@ -7,13 +7,20 @@ properties: cause: type: string example: Role + description: Cause of the expansion item. name: type: string description: The name of the item example: smartsheet-role - attributeRequests: - type: array - items: - $ref: "AttributeRequest.yaml" + attributeRequest: + $ref: "AttributeRequest.yaml" source: $ref: "../AccountSource.yaml" + id: + type: string + description: ID of the expansion item + example: ac2887ffe0e7435a8c18c73f7ae94c7b + state: + type: string + description: State of the expansion item + example: EXECUTING diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml index 6170f4086729..eca8ee3df1bc 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml @@ -4,6 +4,8 @@ properties: type: string description: Account ID. example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com + result: + $ref: "Result.yaml" attributeRequests: type: array description: Attribute changes requested for account. diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/Result.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/Result.yaml new file mode 100644 index 000000000000..8c8c6d5a5038 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/Result.yaml @@ -0,0 +1,6 @@ +type: object +properties: + status: + type: string + description: Request result status + example: "Manual Task Created" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml index 67ae3681ce5f..fe8fbaaaa1aa 100644 --- a/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml @@ -1,11 +1,11 @@ type: object -required: ["id", "name", "_type"] +required: ["id", "name"] properties: id: type: string example: 2c91808375d8e80a0175e1f88a575222 + description: ID of the referenced object. name: type: string example: john.doe - _type: - $ref: "DocumentType.yaml" + description: The human readable name of the referenced object. diff --git a/static/api-specs/idn/v3/schemas/search/model/base/DocumentFields.yaml b/static/api-specs/idn/v3/schemas/search/model/base/DocumentFields.yaml new file mode 100644 index 000000000000..00af29041723 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/base/DocumentFields.yaml @@ -0,0 +1,18 @@ +type: object +properties: + pod: + type: string + example: pod01-useast1 + description: Name of the pod. + org: + type: string + example: org-name + description: Name of the tenant. + _type: + $ref: "DocumentType.yaml" + type: + $ref: "DocumentType.yaml" + _version: + type: string + example: v2 + description: Version number. diff --git a/static/api-specs/idn/v3/schemas/search/model/base/DocumentType.yaml b/static/api-specs/idn/v3/schemas/search/model/base/DocumentType.yaml index b8ec1f1e9de5..8186e4a45192 100644 --- a/static/api-specs/idn/v3/schemas/search/model/base/DocumentType.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/base/DocumentType.yaml @@ -7,8 +7,6 @@ type: string enum: - accessprofile - accountactivity - - account - - aggregation - entitlement - event - identity diff --git a/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml b/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml index 95d99ee52976..02173613ac3a 100644 --- a/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml @@ -8,6 +8,7 @@ properties: description: type: string description: Entitlement's description. + nullable: true example: Cloud engineering attribute: type: string diff --git a/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml index 53f4781071a1..335e55e9c6c1 100644 --- a/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml @@ -33,9 +33,13 @@ allOf: type: string description: Display name of entitlement's source. example: ODS-HR-Employees + type: + type: string + example: SOURCE + description: Type of object. segments: type: array - description: Segments with the role. + description: Segments with the entitlement. items: $ref: '../base/BaseSegment.yaml' segmentCount: @@ -64,10 +68,66 @@ allOf: description: Indicates whether the entitlement is privileged. default: false example: false - identityCount: - type: integer - description: Number of identities who have access to the entitlement. - format: int32 - example: 3 tags: $ref: "../base/Tags.yaml" + attribute: + type: string + description: Attribute information for the entitlement. + example: groups + value: + type: string + description: Value of the entitlement. + example: 1733ff75-441e-4327-9bfc-3ac445fd8cd1 + sourceSchemaObjectType: + type: string + description: Source schema object type of the entitlement. + example: group + schema: + type: string + description: Schema type of the entitlement. + example: group + hash: + type: string + description: Read-only calculated hash value of an entitlement. + example: c6fab95235584cca98a454a2f51e5683bc77d6a0 + attributes: + type: object + additionalProperties: true + description: Attributes of the entitlement. + truncatedAttributes: + type: array + description: Truncated attributes of the entitlement. + items: + type: string + containsDataAccess: + type: boolean + description: Indicates whether the entitlement contains data access. + default: false + manuallyUpdatedFields: + type: object + description: Indicates whether the entitlement's display name and/or description have been manually updated. + nullable: true + properties: + DESCRIPTION: + type: boolean + default: false + example: false + DISPLAY_NAME: + type: boolean + default: false + example: false + permissions: + type: array + items: + type: object + properties: + target: + type: string + description: The target the permission would grants rights on. + example: SYS.GV_$TRANSACTION + rights: + type: array + description: All the rights (e.g. actions) that this permission allows on the target + items: + type: string + example: SELECT \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocuments.yaml b/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocuments.yaml new file mode 100644 index 000000000000..c4bf6f9ef80c --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocuments.yaml @@ -0,0 +1,4 @@ +type: object +allOf: + - $ref: 'EntitlementDocument.yaml' + - $ref: '../base/DocumentFields.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml index d100e400e96f..e9daa6d83261 100644 --- a/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml @@ -1,77 +1,90 @@ +type: object description: Event -allOf: - - $ref: "../base/BaseDocument.yaml" - - type: object - properties: - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: 'date-time' - example: '2018-06-25T20:22:28.104Z' - synced: - type: string - description: >- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. +properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + description: ID of the entitlement. + name: + type: string + example: Add Entitlement Passed + description: Name of the entitlement. + created: + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' + synced: + type: string + description: >- + ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. + This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - action: - type: string - description: Name of the event as it's displayed in audit reports. - example: update - type: - type: string - description: Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - example: SYSTEM_CONFIG - actor: + There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. + example: '2018-06-25T20:22:28.104Z' + action: + type: string + description: Name of the event as it's displayed in audit reports. + example: AddEntitlement + type: + type: string + description: Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. + example: ACCESS_ITEM + actor: + type: object + properties: + name: type: string - description: Name of the actor that generated the event. - example: System - target: + description: Name of the actor that generated the event. + example: System + target: + type: object + properties: + name: type: string description: Name of the target, or recipient, of the event. example: Carol.Adams - stack: - type: string - description: The event's stack. - example: tpe - trackingNumber: - type: string - description: ID of the group of events. - example: 63f891e0735f4cc8bf1968144a1e7440 - ipAddress: - type: string - description: Target system's IP address. - example: "52.52.97.85" - details: - type: string - description: ID of event's details. - example: 73b65dfbed1842548c207432a18c84b0 - attributes: - type: object - description: Attributes involved in the event. - additionalProperties: true - example: - pod: stg03-useast1 - org: acme - sourceName: SailPoint - objects: - type: array - description: Objects the event is happening to. - items: - type: string - example: AUTHENTICATION - operation: - type: string - description: Operation, or action, performed during the event. - example: REQUEST - status: - type: string - description: Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - example: PASSED - technicalName: - type: string - description: Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. - example: AUTHENTICATION_REQUEST_PASSED + stack: + type: string + description: The event's stack. + example: tpe + trackingNumber: + type: string + description: ID of the group of events. + example: 63f891e0735f4cc8bf1968144a1e7440 + ipAddress: + type: string + description: Target system's IP address. + example: "52.52.97.85" + details: + type: string + description: ID of event's details. + example: 73b65dfbed1842548c207432a18c84b0 + attributes: + type: object + description: Attributes involved in the event. + additionalProperties: true + example: + pod: stg03-useast1 + org: acme + sourceName: SailPoint + objects: + type: array + description: Objects the event is happening to. + items: + type: string + example: AUTHENTICATION + operation: + type: string + description: Operation, or action, performed during the event. + example: ADD + status: + type: string + description: Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. + example: PASSED + technicalName: + type: string + description: Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. + example: ENTITLEMENT_ADD_PASSED diff --git a/static/api-specs/idn/v3/schemas/search/model/event/EventDocuments.yaml b/static/api-specs/idn/v3/schemas/search/model/event/EventDocuments.yaml new file mode 100644 index 000000000000..e1a0f5cc5c57 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/event/EventDocuments.yaml @@ -0,0 +1,15 @@ +type: object +allOf: + - $ref: 'EventDocument.yaml' + - properties: + pod: + type: string + example: pod01-useast1 + org: + type: string + example: org-name + _type: + $ref: "../base/DocumentType.yaml" + _version: + type: string + example: v2 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml index 0dc105d5aff3..f73b76f2d06b 100644 --- a/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml @@ -115,11 +115,21 @@ allOf: country: "US" firstname: "Carol" cloudStatus: "UNREGISTERED" + disabled: + type: boolean + description: Indicates whether the identity is disabled. + default: false + example: false + locked: + type: boolean + description: Indicates whether the identity is locked. + default: false + example: false processingState: type: string description: Identity's processing state. nullable: true - example: null + example: ERROR processingDetails: $ref: 'ProcessingDetails.yaml' description: Identity's processing details. @@ -181,3 +191,19 @@ allOf: example: 5 tags: $ref: '../base/Tags.yaml' + tagsCount: + type: integer + format: int32 + description: Number of tags on the identity. + visibleSegments: + type: array + description: List of segments that the identity is in. + items: + type: string + nullable: true + example: [ "All Employees" ] + visibleSegmentCount: + type: integer + format: int32 + description: Number of segments the identity is in. + example: 1 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocuments.yaml b/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocuments.yaml new file mode 100644 index 000000000000..c85b402a3299 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocuments.yaml @@ -0,0 +1,4 @@ +type: object +allOf: + - $ref: 'IdentityDocument.yaml' + - $ref: '../base/DocumentFields.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml index 99ee9dad13ad..58f68f4dc8f8 100644 --- a/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml @@ -1,38 +1,133 @@ description: Role allOf: -- $ref: '../base/BaseDocument.yaml' - $ref: '../access/BaseAccess.yaml' - type: object + required: ["id", "name"] properties: + id: + type: string + example: 2c91808375d8e80a0175e1f88a575222 + description: ID of the role. + name: + type: string + example: Branch Manager Access + description: Name of the role. accessProfiles: type: array description: Access profiles included with the role. + nullable: true items: $ref: '../base/BaseAccessProfile.yaml' accessProfileCount: type: integer description: Number of access profiles included with the role. + nullable: true format: int32 example: 1 tags: $ref: '../base/Tags.yaml' + nullable: true segments: type: array description: Segments with the role. + nullable: true items: $ref: '../base/BaseSegment.yaml' segmentCount: type: integer description: Number of segments with the role. + nullable: true format: int32 example: 1 entitlements: type: array - description: Entitlements included with the role. + description: Entitlements included with the role. + nullable: true items: - $ref: '../entitlement/BaseEntitlement.yaml' + allOf: + - $ref: '../entitlement/BaseEntitlement.yaml' + - properties: + sourceSchemaObjectType: + type: string + description: Schema objectType. + example: group + hash: + type: string + description: Read-only calculated hash value of an entitlement. + example: c6fab95235584cca98a454a2f51e5683bc77d6a0 entitlementCount: type: integer description: Number of entitlements included with the role. + nullable: true format: int32 - example: 3 \ No newline at end of file + example: 3 + dimensional: + type: boolean + example: false + default: false + dimensionSchemaAttributeCount: + type: integer + description: Number of dimension attributes included with the role. + nullable: true + format: int32 + example: 3 + dimensionSchemaAttributes: + type: array + description: Dimension attributes included with the role. + nullable: true + items: + type: object + properties: + derived: + type: boolean + example: true + default: true + displayName: + type: string + description: Displayname of the dimension attribute. + example: Department + name: + type: string + description: Name of the dimension attribute. + example: department + dimensions: + type: array + nullable: true + items: + type: object + properties: + id: + type: string + description: Unique ID of the dimension. + example: b3c28992ba964a40a7598978139d1ced + name: + type: string + description: Name of the dimension. + example: Manager Austin Branch + description: + type: string + nullable: true + description: Description of the dimension. + example: Managers located at the Austin branch + entitlements: + type: array + description: Entitlements included with the role. + nullable: true + items: + allOf: + - $ref: '../entitlement/BaseEntitlement.yaml' + - properties: + sourceSchemaObjectType: + type: string + description: Schema objectType. + example: group + hash: + type: string + description: Read-only calculated hash value of an entitlement. + example: c6fab95235584cca98a454a2f51e5683bc77d6a0 + accessProfiles: + type: array + nullable: true + description: Access profiles included in the dimension. + items: + $ref: '../base/BaseAccessProfile.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/model/role/RoleDocuments.yaml b/static/api-specs/idn/v3/schemas/search/model/role/RoleDocuments.yaml new file mode 100644 index 000000000000..5f85e2aee7ef --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/role/RoleDocuments.yaml @@ -0,0 +1,4 @@ +type: object +allOf: + - $ref: 'RoleDocument.yaml' + - $ref: '../base/DocumentFields.yaml' \ No newline at end of file