From 6ed21670e4536f9f8a3c69b7ca76b822577ff52c Mon Sep 17 00:00:00 2001 From: philip-ellis-sp Date: Wed, 12 Oct 2022 14:54:33 -0400 Subject: [PATCH] removed postman files --- ..._0e6cd4e9-8a31-467a-910d-d14f419ce416.json | 65149 ----------- postman/schemas/sailpoint-api.v3.yaml | 93529 ---------------- 2 files changed, 158678 deletions(-) delete mode 100644 postman/collections/IdentityNow V3 API_0e6cd4e9-8a31-467a-910d-d14f419ce416.json delete mode 100644 postman/schemas/sailpoint-api.v3.yaml diff --git a/postman/collections/IdentityNow V3 API_0e6cd4e9-8a31-467a-910d-d14f419ce416.json b/postman/collections/IdentityNow V3 API_0e6cd4e9-8a31-467a-910d-d14f419ce416.json deleted file mode 100644 index 1a21db4..0000000 --- a/postman/collections/IdentityNow V3 API_0e6cd4e9-8a31-467a-910d-d14f419ce416.json +++ /dev/null @@ -1,65149 +0,0 @@ -{ - "info": { - "_postman_id": "40e0c653-f27a-4bf9-85b7-3ff023cad322", - "name": "IdentityNow V3 API", - "description": "Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.\n\nContact Support:\n Name: Developer Relations", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" - }, - "item": [ - { - "name": "Access Request Approvals", - "item": [ - { - "name": "Pending Access Request Approvals List", - "id": "27193abb-7a46-4d64-84ab-1ea7b83d4172", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/pending?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "pending" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313", - "description": "If present, the value returns only pending approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*" - }, - { - "key": "sorters", - "value": "modified", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**" - } - ], - "variable": [ - { - "id": "96d1b5ba-a353-4498-8c25-3c9d13501e83", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info." - }, - "response": [ - { - "id": "bddeba2b-0aee-4086-89f4-3af1ffb14b31", - "name": "List of Pending Approvals.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/pending?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "pending" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-07-25T20:22:28.104Z\",\n \"requestCreated\": \"2017-07-11T18:45:35.098Z\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedObject\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Applied Research Access\",\n \"description\": \"Access to research information, lab results, and schematics\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"frank.mir\",\n \"newApproverName\": \"al.volta\",\n \"comment\": \"Fusce id orci vel consectetur amet ipsum quam.\",\n \"modified\": \"2019-08-23T18:52:57.398Z\"\n },\n {\n \"oldApproverName\": \"frank.mir\",\n \"newApproverName\": \"al.volta\",\n \"comment\": \"Fusce id orci vel consectetur amet ipsum quam.\",\n \"modified\": \"2019-08-23T18:52:57.398Z\"\n }\n ],\n \"commentRequiredWhenRejected\": true,\n \"actionInProcess\": \"APPROVED\",\n \"removeDate\": \"2020-07-11T00:00:00Z\",\n \"removeDateUpdateRequested\": true,\n \"currentRemoveDate\": \"2020-07-11T00:00:00Z\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"f73d16e9-a038-46c5-b217-1246e15fdbdd\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-07-25T20:22:28.104Z\",\n \"requestCreated\": \"2017-07-11T18:45:35.098Z\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedObject\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Applied Research Access\",\n \"description\": \"Access to research information, lab results, and schematics\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"frank.mir\",\n \"newApproverName\": \"al.volta\",\n \"comment\": \"Fusce id orci vel consectetur amet ipsum quam.\",\n \"modified\": \"2019-08-23T18:52:57.398Z\"\n },\n {\n \"oldApproverName\": \"frank.mir\",\n \"newApproverName\": \"al.volta\",\n \"comment\": \"Fusce id orci vel consectetur amet ipsum quam.\",\n \"modified\": \"2019-08-23T18:52:57.398Z\"\n }\n ],\n \"commentRequiredWhenRejected\": true,\n \"actionInProcess\": \"APPROVED\",\n \"removeDate\": \"2020-07-11T00:00:00Z\",\n \"removeDateUpdateRequested\": true,\n \"currentRemoveDate\": \"2020-07-11T00:00:00Z\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"f73d16e9-a038-46c5-b217-1246e15fdbdd\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n ]\n }\n }\n }\n]" - }, - { - "id": "aa8c80e7-73a7-4727-b89b-ea0ebcc3819e", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/pending?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "pending" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "a536939b-db43-43d2-80ad-2e365d6d0149", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/pending?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "pending" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ba013a29-eed3-4e48-9364-b24324ba5038", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/pending?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "pending" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "15af9d50-888f-42a9-8525-56a01c2d9b14", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/pending?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "pending" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "4393b6eb-d608-4951-8b3d-afa507f347fe", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/pending?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "pending" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Completed Access Request Approvals List", - "id": "759300b7-b663-4759-8cd4-3b26067d5a60", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/completed?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "completed" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313", - "description": "If present, the value returns only completed approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*" - }, - { - "key": "sorters", - "value": "modified", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**" - } - ], - "variable": [ - { - "id": "88ad2211-258b-40a8-a33b-6f184f17e571", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info." - }, - "response": [ - { - "id": "675fafe9-6925-43b7-afc0-9aaaa8a415f2", - "name": "List of Completed Approvals.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/completed?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "completed" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-07-25T20:22:28.104Z\",\n \"requestCreated\": \"2017-07-11T18:45:35.098Z\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedObject\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Applied Research Access\",\n \"description\": \"Access to research information, lab results, and schematics\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerComment\": {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"frank.mir\",\n \"newApproverName\": \"al.volta\",\n \"comment\": \"Fusce id orci vel consectetur amet ipsum quam.\",\n \"modified\": \"2019-08-23T18:52:57.398Z\"\n },\n {\n \"oldApproverName\": \"frank.mir\",\n \"newApproverName\": \"al.volta\",\n \"comment\": \"Fusce id orci vel consectetur amet ipsum quam.\",\n \"modified\": \"2019-08-23T18:52:57.398Z\"\n }\n ],\n \"commentRequiredWhenRejected\": true,\n \"state\": \"APPROVED\",\n \"removeDate\": \"2020-07-11T00:00:00Z\",\n \"removeDateUpdateRequested\": true,\n \"currentRemoveDate\": \"2020-07-11T00:00:00Z\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"f73d16e9-a038-46c5-b217-1246e15fdbdd\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-07-25T20:22:28.104Z\",\n \"requestCreated\": \"2017-07-11T18:45:35.098Z\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedObject\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Applied Research Access\",\n \"description\": \"Access to research information, lab results, and schematics\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerComment\": {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"frank.mir\",\n \"newApproverName\": \"al.volta\",\n \"comment\": \"Fusce id orci vel consectetur amet ipsum quam.\",\n \"modified\": \"2019-08-23T18:52:57.398Z\"\n },\n {\n \"oldApproverName\": \"frank.mir\",\n \"newApproverName\": \"al.volta\",\n \"comment\": \"Fusce id orci vel consectetur amet ipsum quam.\",\n \"modified\": \"2019-08-23T18:52:57.398Z\"\n }\n ],\n \"commentRequiredWhenRejected\": true,\n \"state\": \"APPROVED\",\n \"removeDate\": \"2020-07-11T00:00:00Z\",\n \"removeDateUpdateRequested\": true,\n \"currentRemoveDate\": \"2020-07-11T00:00:00Z\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"f73d16e9-a038-46c5-b217-1246e15fdbdd\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n ]\n }\n }\n }\n]" - }, - { - "id": "97031c44-2209-4c9d-a633-420c48fe22bf", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/completed?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "completed" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "06c15820-b133-4976-b65c-7f9dbccca216", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/completed?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "completed" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ca8325c9-100d-4b2d-bb55-cb3a8c2ec143", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/completed?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "completed" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1b1575e6-0c77-431c-b3e3-dcdb29cac726", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/completed?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "completed" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "210f5c80-e1f4-4e3e-8eb6-1cb39ce64fbc", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/completed?owner-id=2c91808568c529c60168cca6f90c1313&limit=250&offset=0&count=true&filters=id eq \"2c91808568c529c60168cca6f90c1313\"&sorters=modified", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "completed" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "id eq \"2c91808568c529c60168cca6f90c1313\"" - }, - { - "key": "sorters", - "value": "modified" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Approves an access request approval.", - "id": "93c88e2c-10b5-4c5a-a6c0-4d07042b1c59", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "approve" - ], - "variable": [ - { - "id": "2f551e43-25e6-4466-a48b-253115067d52", - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "id": "472285db-32cb-41b1-aa32-fe063c232179", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action." - }, - "response": [ - { - "id": "15624920-26e0-4d11-9bdb-0fe63ed0bc40", - "name": "Accepted - Returned if the request was successfully accepted into the system.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "approve" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{}" - }, - { - "id": "b98a8146-3723-4de4-979b-aa0e59e8e2d7", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "approve" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "bab0cb7d-9f7a-4f00-b7dc-a7b31adfcb7e", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "approve" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "4ec6e837-b2fc-4db6-af86-49c39022f56a", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "approve" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "d17ebfe7-ac99-47ad-9638-75c5be857e55", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "approve" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "99e427ec-6dac-4e84-87dc-f759e467b36d", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "approve" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "f1419c38-8405-4cb4-99ce-e0e300729649", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "approve" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Rejects an access request approval.", - "id": "3ead94a5-907c-46b5-a10d-384ba8f02bee", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "reject" - ], - "variable": [ - { - "id": "5ce64e38-5a94-470e-afea-6a3ff5133cf3", - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "id": "d397e92a-c770-47fc-8d45-3cc406c94ee0", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action." - }, - "response": [ - { - "id": "20a0322b-65f4-47fc-a940-340f3f689978", - "name": "Accepted - Returned if the request was successfully accepted into the system.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "reject" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{}" - }, - { - "id": "3d1b2cb1-f0f1-47bf-b69a-3526f074a4e7", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "reject" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0e4643eb-a210-472e-afd8-b705fcdcf7b3", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "reject" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "5e2343b0-c505-420e-a258-ee3dff9f0a63", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "reject" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "6f6878ff-ae66-4d7d-a2c0-2047c297e0ee", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "reject" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "1220300f-ba47-4cc6-bcb6-1f82d072c3b1", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "reject" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "51d9f0e0-f52c-4a7d-8cee-cd8e816a2929", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "reject" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Forwards an access request approval.", - "id": "480268a6-348a-41a5-8f4d-24495a8126fe", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"newOwnerId\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"comment\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/forward", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "forward" - ], - "variable": [ - { - "id": "0165d56b-c621-4057-ba43-e0e1cc6bcd07", - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "id": "b958f2a5-6ada-4613-b3da-4f720f6327a9", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action." - }, - "response": [ - { - "id": "52f10b3c-06ea-4082-ac64-65ba99be1ae9", - "name": "Accepted - Returned if the request was successfully accepted into the system.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"newOwnerId\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"comment\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/forward", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "forward" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{}" - }, - { - "id": "b748f3f7-aa08-4311-b658-32476971d675", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"newOwnerId\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"comment\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/forward", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "forward" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "50fd2a26-892c-4633-9c09-06da6c8d6f2c", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"newOwnerId\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"comment\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/forward", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "forward" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "15db942c-9782-4e9b-b393-8d384f062234", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"newOwnerId\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"comment\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/forward", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "forward" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "838003d9-6f5e-4270-a0ff-9dfdef938290", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"newOwnerId\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"comment\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/forward", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "forward" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "b63d7e0e-4a6a-444b-bac4-eabe20671e1a", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"newOwnerId\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"comment\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/forward", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "forward" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "673bc6b5-d0c2-4971-98f2-b3af8ae5b065", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"newOwnerId\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"comment\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-approvals/:approvalId/forward", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - ":approvalId", - "forward" - ], - "variable": [ - { - "key": "approvalId", - "value": "2c91808b7294bea301729568c68c002e", - "description": "(Required) The id of the approval." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get the number of access-requests-approvals", - "id": "d22e312c-ede0-4d6d-a5c3-666f74724348", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/approval-summary?owner-id=2c91808568c529c60168cca6f90c1313&from-date=from-date=2020-03-19T19:59:11Z", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "approval-summary" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313", - "description": "The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value." - }, - { - "key": "from-date", - "value": "from-date=2020-03-19T19:59:11Z", - "description": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format" - } - ], - "variable": [ - { - "id": "9b8327e2-9620-4042-84e6-52510154ee12", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info." - }, - "response": [ - { - "id": "67474e6d-2090-4151-bedf-333e986efc22", - "name": "Number of pending, approved, rejected access request approvals.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/approval-summary?owner-id=2c91808568c529c60168cca6f90c1313&from-date=from-date=2020-03-19T19:59:11Z", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "approval-summary" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "from-date", - "value": "from-date=2020-03-19T19:59:11Z" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"pending\": 0,\n \"approved\": 0,\n \"rejected\": 0\n}" - }, - { - "id": "1275b258-9c1a-40f6-b61a-f881605ccd30", - "name": "Client Error - Returned if the query parameter is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/approval-summary?owner-id=2c91808568c529c60168cca6f90c1313&from-date=from-date=2020-03-19T19:59:11Z", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "approval-summary" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "from-date", - "value": "from-date=2020-03-19T19:59:11Z" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "a90df84b-bcd7-4652-bb3c-c76f4c3a7126", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/approval-summary?owner-id=2c91808568c529c60168cca6f90c1313&from-date=from-date=2020-03-19T19:59:11Z", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "approval-summary" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "from-date", - "value": "from-date=2020-03-19T19:59:11Z" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "3cd4c2db-7d67-4a00-9003-4d5774420b5a", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/approval-summary?owner-id=2c91808568c529c60168cca6f90c1313&from-date=from-date=2020-03-19T19:59:11Z", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "approval-summary" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "from-date", - "value": "from-date=2020-03-19T19:59:11Z" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "db3cc6f7-a331-45c6-8f66-466f3f266678", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/approval-summary?owner-id=2c91808568c529c60168cca6f90c1313&from-date=from-date=2020-03-19T19:59:11Z", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "approval-summary" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "from-date", - "value": "from-date=2020-03-19T19:59:11Z" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "a8cd19f1-1d25-4187-ac51-2f69d0b8e575", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-approvals/approval-summary?owner-id=2c91808568c529c60168cca6f90c1313&from-date=from-date=2020-03-19T19:59:11Z", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-approvals", - "approval-summary" - ], - "query": [ - { - "key": "owner-id", - "value": "2c91808568c529c60168cca6f90c1313" - }, - { - "key": "from-date", - "value": "from-date=2020-03-19T19:59:11Z" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "76a3f27f-92e9-4d13-bcd4-d0f8a40dfc65", - "description": "Use this API to implement and customize access request approval functionality. \nWith this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. \nThis enables more qualified users to review access requests and the others to spend their time on other tasks. \n\nIn IdentityNow, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. \nFor applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. \nFor roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. \nIf the administrator designates a governance group as the required approver, any governance group member can approve the requests.\n \nWhen a user submits an access request, IdentityNow sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration.\n\nIn Approvals in IdentityNow, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. \nIf the required approver approves the request and is the only reviewer required, IdentityNow grants or revokes access, based on the request. \nIf multiple reviewers are required, IdentityNow sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. \nThe required approver can then view any completed access requests under the Reviewed tab. \n\nRefer to the following link for more information about access request approvals:\n" - }, - { - "name": "Access Requests", - "item": [ - { - "name": "Submit an Access Request", - "id": "6ee72665-9e9d-4ca2-8448-2b95506931aa", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210584\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\",\n \"requestedAppName\": \"test-app\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests" - ], - "variable": [ - { - "id": "a418c47c-da4d-4569-8476-6acbf7114744", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes.\n\nAccess requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request\nhas been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error\nif you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected.\nIt is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can\nbe accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also\nuse the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting\nan access request to ensure you are not requesting access that is already granted.\n\nThere are two types of access request:\n\n__GRANT_ACCESS__\n* Can be requested for multiple identities in a single request.\n* Supports self request and request on behalf of other users, see '/beta/access-request-config' endpoint for request configuration options. \n* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.\n* Roles, Access Profiles and Entitlements can be requested.\n* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.\n \n__REVOKE_ACCESS__\n* Can only be requested for a single identity at a time.\n* Does not support self request. Only manager can request to revoke access for their directly managed employees.\n* If removeDate is specified, then the access will be removed on that date and time.\n* Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone.\n* Roles and Access Profiles can be requested for revocation. Revoke request for entitlements are not supported currently.\n\nNOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API.\n\nA token with API authority cannot be used to call this endpoint. \n" - }, - "response": [ - { - "id": "c0a798ae-8853-4bc2-ab2e-529b3d17fe3f", - "name": "Accepted - Returned if the request was successfully accepted into the system.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210584\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\",\n \"requestedAppName\": \"test-app\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{}" - }, - { - "id": "e77a36b6-da46-49b2-ad99-3c6093657b89", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210584\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\",\n \"requestedAppName\": \"test-app\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "dabe3783-8079-40f4-85a4-542d6db91b3a", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210584\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\",\n \"requestedAppName\": \"test-app\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "fc827492-7fe9-4571-8df2-bb29d2ba96ff", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210584\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\",\n \"requestedAppName\": \"test-app\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "250d3503-07dd-433f-a08a-2f4313108318", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210584\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\",\n \"requestedAppName\": \"test-app\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "4a41fe92-8e96-492a-b1e4-0ba4bef01c46", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedFor\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210584\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"Requesting access profile for John Doe\",\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"removeDate\": \"2020-07-11T21:23:15.000Z\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\",\n \"requestedAppName\": \"test-app\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Cancel Access Request", - "id": "f617c07a-b7f8-42ef-a670-edf6be9aba74", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountActivityId\": \"2c91808568c529c60168cca6f90c1313\",\n \"comment\": \"I requested this role by mistake.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests", - "cancel" - ], - "variable": [ - { - "id": "ca70972c-dfad-4167-b754-d564228a8c2d", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.\nAny token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it." - }, - "response": [ - { - "id": "d2a5cd59-8416-4e93-a3ba-a49918b0abb6", - "name": "Accepted - Returned if the request was successfully accepted into the system.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountActivityId\": \"2c91808568c529c60168cca6f90c1313\",\n \"comment\": \"I requested this role by mistake.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests", - "cancel" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{}" - }, - { - "id": "fdf8b43b-6767-44dd-b246-3c141f22ea26", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountActivityId\": \"2c91808568c529c60168cca6f90c1313\",\n \"comment\": \"I requested this role by mistake.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests", - "cancel" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "f41c42c5-29b1-4aba-b0f0-214ad346a8f0", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountActivityId\": \"2c91808568c529c60168cca6f90c1313\",\n \"comment\": \"I requested this role by mistake.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests", - "cancel" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "e7b5450a-bdfd-4c56-94af-09b8fb633c55", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountActivityId\": \"2c91808568c529c60168cca6f90c1313\",\n \"comment\": \"I requested this role by mistake.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests", - "cancel" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "43bf0971-03c3-43c7-b5b7-b528db92366b", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountActivityId\": \"2c91808568c529c60168cca6f90c1313\",\n \"comment\": \"I requested this role by mistake.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests", - "cancel" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "c2cc4fee-158a-4cd7-8d92-01a800cd55e3", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountActivityId\": \"2c91808568c529c60168cca6f90c1313\",\n \"comment\": \"I requested this role by mistake.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests", - "cancel" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "313c87dd-e193-4c35-b6d1-10317c014a09", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountActivityId\": \"2c91808568c529c60168cca6f90c1313\",\n \"comment\": \"I requested this role by mistake.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-requests/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-requests", - "cancel" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Access Request Configuration", - "id": "dcb40d47-3114-4e27-ae40-1a137367e1e9", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "id": "780ca105-ac48-4619-87f3-206eb81f4151", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint returns the current access-request configuration." - }, - "response": [ - { - "id": "bd6ed438-4f83-4f2b-badc-f1d498e754e8", - "name": "Access Request Configuration Details.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}" - }, - { - "id": "b4668baa-5ae3-4bfa-9463-4b789aedb433", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "824b40bc-3075-4ce4-8b8d-c709504e3177", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "22a0b9d7-473a-482f-a0eb-c208d9ea2526", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "bf2ada00-399a-4964-811a-1604ae6c3204", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "26af6113-cbff-4e43-bac0-1d7f4c0ecff4", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Access Request Configuration", - "id": "9f4c8ab5-ae1e-4374-b053-8e671103d03f", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "id": "79b08985-eefe-49ae-9689-ca4c4b91ce00", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint replaces the current access-request configuration.\nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "c14a6873-8113-4b09-bc3b-3b8af5a73c63", - "name": "Access Request Configuration Details.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}" - }, - { - "id": "98367360-accd-4cd9-8940-d2feec44eed9", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "7858d30a-353f-43d1-bd69-72d52c1b36d7", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "01760a6e-92dc-4981-b823-1d870456b614", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "85880174-5843-485b-a779-390f2c56b408", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "ada3342f-f8e0-4ffc-bbf9-396dcfd0b028", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 0,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/access-request-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Access Request Status", - "id": "fca6895d-24d3-4050-8305-47d8204108b5", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-status?requested-for=2c9180877b2b6ea4017b2c545f971429&requested-by=2c9180877b2b6ea4017b2c545f971429®arding-identity=2c9180877b2b6ea4017b2c545f971429&count=false&limit=100&offset=10&filters=accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"&sorters=created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-status" - ], - "query": [ - { - "key": "requested-for", - "value": "2c9180877b2b6ea4017b2c545f971429", - "description": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*." - }, - { - "key": "requested-by", - "value": "2c9180877b2b6ea4017b2c545f971429", - "description": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*." - }, - { - "key": "regarding-identity", - "value": "2c9180877b2b6ea4017b2c545f971429", - "description": "Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*." - }, - { - "key": "count", - "value": "false", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored." - }, - { - "key": "limit", - "value": "100", - "description": "Max number of results to return." - }, - { - "key": "offset", - "value": "10", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified." - }, - { - "key": "filters", - "value": "accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**accountActivityItemId**: *eq, in*" - }, - { - "key": "sorters", - "value": "created", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified, accountActivityItemId**" - } - ], - "variable": [ - { - "id": "6517de0c-ff13-4a73-9d2a-617d7e361b05", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "The Access Request Status API returns a list of access request statuses based on the specified query parameters.\nAny token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users." - }, - "response": [ - { - "id": "7af09382-817f-45cb-95db-85b41449dd60", - "name": "List of requested item status.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-status?requested-for=2c9180877b2b6ea4017b2c545f971429&requested-by=2c9180877b2b6ea4017b2c545f971429®arding-identity=2c9180877b2b6ea4017b2c545f971429&count=false&limit=100&offset=10&filters=accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"&sorters=created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-status" - ], - "query": [ - { - "key": "requested-for", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "requested-by", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "regarding-identity", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "count", - "value": "false" - }, - { - "key": "limit", - "value": "100" - }, - { - "key": "offset", - "value": "10" - }, - { - "key": "filters", - "value": "accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"" - }, - { - "key": "sorters", - "value": "created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"name\": \"AccessProfile1\",\n \"type\": \"ACCESS_PROFILE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"Nisl quis ipsum quam quisque condimentum nunc ut dolor nunc.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-12-20T09:17:12.192Z\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n ],\n \"state\": \"EXECUTING\",\n \"approvalDetails\": [\n {\n \"forwarded\": true,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\",\n \"scheme\": \"APP_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"comment\": \"nostrud magna\",\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n },\n {\n \"forwarded\": true,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\",\n \"scheme\": \"APP_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"comment\": \"pariatur velit\",\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": true,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\"\n },\n {\n \"forwarded\": true,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\"\n }\n ],\n \"accountActivityItemId\": \"2c9180926cbfbddd016cbfc7c3b10010\",\n \"requestType\": \"GRANT_ACCESS\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requesterComment\": {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"f73d16e9-a038-46c5-b217-1246e15fdbdd\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"manualWorkItemDetails\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"Access is Approved\",\n \"reviewer\": \"John Doe\",\n \"decision\": \"APPROVED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"2020-07-11T00:00:00Z\",\n \"finished\": \"2020-07-12T00:00:00Z\",\n \"name\": \"APPROVAL_PHASE\",\n \"state\": \"COMPLETED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"approvalDetails\"\n },\n {\n \"started\": \"2020-07-11T00:00:00Z\",\n \"finished\": \"2020-07-12T00:00:00Z\",\n \"name\": \"APPROVAL_PHASE\",\n \"state\": \"COMPLETED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"approvalDetails\"\n }\n ],\n \"description\": \"This is the Engineering role that engineers are granted.\",\n \"removeDate\": \"2019-10-23T00:00:00.000Z\",\n \"cancelable\": true,\n \"accessRequestId\": \"b3a5ba9e-1941-acb7-e84c-b856702a1770\"\n },\n {\n \"name\": \"AccessProfile1\",\n \"type\": \"ACCESS_PROFILE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"Nisl quis ipsum quam quisque condimentum nunc ut dolor nunc.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-12-20T09:17:12.192Z\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n ],\n \"state\": \"EXECUTING\",\n \"approvalDetails\": [\n {\n \"forwarded\": false,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\",\n \"scheme\": \"ACCESS_PROFILE_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"comment\": \"culpa irur\",\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n },\n {\n \"forwarded\": true,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"reviewedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\",\n \"scheme\": \"SOURCE_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"comment\": \"deserunt qui amet\",\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": true,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\"\n },\n {\n \"forwarded\": true,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\"\n }\n ],\n \"accountActivityItemId\": \"2c9180926cbfbddd016cbfc7c3b10010\",\n \"requestType\": \"GRANT_ACCESS\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"requesterComment\": {\n \"comment\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Adam Kennedy\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"f73d16e9-a038-46c5-b217-1246e15fdbdd\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"existing\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"manualWorkItemDetails\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"Access is Approved\",\n \"reviewer\": \"John Doe\",\n \"decision\": \"APPROVED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"2020-07-11T00:00:00Z\",\n \"finished\": \"2020-07-12T00:00:00Z\",\n \"name\": \"APPROVAL_PHASE\",\n \"state\": \"COMPLETED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"approvalDetails\"\n },\n {\n \"started\": \"2020-07-11T00:00:00Z\",\n \"finished\": \"2020-07-12T00:00:00Z\",\n \"name\": \"APPROVAL_PHASE\",\n \"state\": \"COMPLETED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"approvalDetails\"\n }\n ],\n \"description\": \"This is the Engineering role that engineers are granted.\",\n \"removeDate\": \"2019-10-23T00:00:00.000Z\",\n \"cancelable\": true,\n \"accessRequestId\": \"63975d0f-1e5a-cb7b-0eda-2740b0b4cb86\"\n }\n]" - }, - { - "id": "92c80c64-a3ba-41b4-9e9b-200713fb449b", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-status?requested-for=2c9180877b2b6ea4017b2c545f971429&requested-by=2c9180877b2b6ea4017b2c545f971429®arding-identity=2c9180877b2b6ea4017b2c545f971429&count=false&limit=100&offset=10&filters=accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"&sorters=created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-status" - ], - "query": [ - { - "key": "requested-for", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "requested-by", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "regarding-identity", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "count", - "value": "false" - }, - { - "key": "limit", - "value": "100" - }, - { - "key": "offset", - "value": "10" - }, - { - "key": "filters", - "value": "accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"" - }, - { - "key": "sorters", - "value": "created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "2b8bb680-24d2-4111-9c5b-43e7189fba19", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-status?requested-for=2c9180877b2b6ea4017b2c545f971429&requested-by=2c9180877b2b6ea4017b2c545f971429®arding-identity=2c9180877b2b6ea4017b2c545f971429&count=false&limit=100&offset=10&filters=accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"&sorters=created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-status" - ], - "query": [ - { - "key": "requested-for", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "requested-by", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "regarding-identity", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "count", - "value": "false" - }, - { - "key": "limit", - "value": "100" - }, - { - "key": "offset", - "value": "10" - }, - { - "key": "filters", - "value": "accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"" - }, - { - "key": "sorters", - "value": "created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "9895a48d-86c6-4f05-8418-ef1a218bdc23", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-status?requested-for=2c9180877b2b6ea4017b2c545f971429&requested-by=2c9180877b2b6ea4017b2c545f971429®arding-identity=2c9180877b2b6ea4017b2c545f971429&count=false&limit=100&offset=10&filters=accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"&sorters=created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-status" - ], - "query": [ - { - "key": "requested-for", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "requested-by", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "regarding-identity", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "count", - "value": "false" - }, - { - "key": "limit", - "value": "100" - }, - { - "key": "offset", - "value": "10" - }, - { - "key": "filters", - "value": "accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"" - }, - { - "key": "sorters", - "value": "created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "fc80f92e-69fc-4c96-8333-cb95ab70362e", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-status?requested-for=2c9180877b2b6ea4017b2c545f971429&requested-by=2c9180877b2b6ea4017b2c545f971429®arding-identity=2c9180877b2b6ea4017b2c545f971429&count=false&limit=100&offset=10&filters=accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"&sorters=created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-status" - ], - "query": [ - { - "key": "requested-for", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "requested-by", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "regarding-identity", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "count", - "value": "false" - }, - { - "key": "limit", - "value": "100" - }, - { - "key": "offset", - "value": "10" - }, - { - "key": "filters", - "value": "accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"" - }, - { - "key": "sorters", - "value": "created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "0659cad5-003f-4681-9a9f-74a2a0efa903", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/access-request-status?requested-for=2c9180877b2b6ea4017b2c545f971429&requested-by=2c9180877b2b6ea4017b2c545f971429®arding-identity=2c9180877b2b6ea4017b2c545f971429&count=false&limit=100&offset=10&filters=accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"&sorters=created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "access-request-status" - ], - "query": [ - { - "key": "requested-for", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "requested-by", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "regarding-identity", - "value": "2c9180877b2b6ea4017b2c545f971429" - }, - { - "key": "count", - "value": "false" - }, - { - "key": "limit", - "value": "100" - }, - { - "key": "offset", - "value": "10" - }, - { - "key": "filters", - "value": "accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"" - }, - { - "key": "sorters", - "value": "created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "10e216da-3d1c-4aae-82d8-4dec702463e2", - "description": "Use this API to implement and customize access request functionality. \nWith this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked.\nThis allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. \n\nIdentityNow's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them.\n\nIn the Request Center in IdentityNow, users can view available applications, roles, and entitlements and request access to them. \nIf the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. \n\nUsers can use My Requests to track and/or cancel the requests.\n\nIn My Team on the IdentityNow Home, managers can submit requests to revoke their team members' access. \nThey can use the My Requests tab under Request Center to track and/or cancel the requests.\n\nRefer to the following link for more information about access requests:\n" - }, - { - "name": "Accounts", - "item": [ - { - "name": "Accounts List", - "id": "8c439ce5-e175-4d4b-b1dd-5471ed3690a3", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts?limit=250&offset=0&count=true&filters=identityId eq \"2c9180858082150f0180893dbaf44201\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "identityId eq \"2c9180858082150f0180893dbaf44201\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**identityId**: *eq*\n\n**name**: *eq, in*\n\n**nativeIdentity**: *eq, in*\n\n**sourceId**: *eq, in*\n\n**uncorrelated**: *eq*" - } - ], - "variable": [ - { - "id": "d36d06ab-6c88-4502-bf93-d6af3c6cffa6", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This returns a list of accounts. \nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "0a694af4-2478-4aa2-a8f5-aacd7c3e9a0b", - "name": "List of account objects", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts?limit=250&offset=0&count=true&filters=identityId eq \"2c9180858082150f0180893dbaf44201\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "identityId eq \"2c9180858082150f0180893dbaf44201\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"name\": \"aName\",\n \"id\": \"id12345\",\n \"created\": \"1983-05-04T16:08:34.590Z\",\n \"modified\": \"1996-11-08T03:10:33.102Z\",\n \"sourceId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"identityId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"attributes\": {},\n \"authoritative\": true,\n \"description\": \"ex consequat adipisicing\",\n \"disabled\": true,\n \"locked\": true,\n \"nativeIdentity\": \"quis Ut ad veniam\",\n \"systemAccount\": false,\n \"uncorrelated\": false,\n \"uuid\": \"aliquip nulla dolore deserunt nostr\",\n \"manuallyCorrelated\": false,\n \"hasEntitlements\": false\n },\n {\n \"name\": \"aName\",\n \"id\": \"id12345\",\n \"created\": \"2003-06-17T17:39:01.230Z\",\n \"modified\": \"2010-09-29T13:54:15.740Z\",\n \"sourceId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"identityId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"attributes\": {},\n \"authoritative\": false,\n \"description\": \"in commodo el\",\n \"disabled\": true,\n \"locked\": false,\n \"nativeIdentity\": \"enim incididunt pariatur\",\n \"systemAccount\": true,\n \"uncorrelated\": true,\n \"uuid\": \"dolore labore\",\n \"manuallyCorrelated\": true,\n \"hasEntitlements\": true\n }\n]" - }, - { - "id": "d01c796e-b1a8-4929-a128-71e9733156ca", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts?limit=250&offset=0&count=true&filters=identityId eq \"2c9180858082150f0180893dbaf44201\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "identityId eq \"2c9180858082150f0180893dbaf44201\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "7848feb1-7b14-4573-953f-2e5aeb1c022f", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts?limit=250&offset=0&count=true&filters=identityId eq \"2c9180858082150f0180893dbaf44201\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "identityId eq \"2c9180858082150f0180893dbaf44201\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "92cd9a42-fb59-40e1-ae13-f8c2baae912a", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts?limit=250&offset=0&count=true&filters=identityId eq \"2c9180858082150f0180893dbaf44201\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "identityId eq \"2c9180858082150f0180893dbaf44201\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "46114180-2d5f-4cbb-8cfa-d6367cae7d44", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts?limit=250&offset=0&count=true&filters=identityId eq \"2c9180858082150f0180893dbaf44201\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "identityId eq \"2c9180858082150f0180893dbaf44201\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "7de7a90a-717f-4f35-984b-9c709d68a9a5", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts?limit=250&offset=0&count=true&filters=identityId eq \"2c9180858082150f0180893dbaf44201\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "identityId eq \"2c9180858082150f0180893dbaf44201\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create Account", - "id": "f8719d00-786d-4fa6-b7c6-0ce1ea24b64f", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"sourceId\": \"34bfcbe116c9407464af37acbaf7a4dc\",\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "variable": [ - { - "id": "ca0792a9-2cdd-46e3-a162-5e3b58e02b5d", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API submits an account creation task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "2cdbf9aa-140d-4207-9461-a56e57ee4d20", - "name": "Async task details", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"sourceId\": \"34bfcbe116c9407464af37acbaf7a4dc\",\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808474683da6017468693c260195\"\n}" - }, - { - "id": "6a32cf1d-0801-4482-b53b-c9dab6f158c4", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"sourceId\": \"34bfcbe116c9407464af37acbaf7a4dc\",\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b1f1600d-c92c-4680-b0e1-151ff400a451", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"sourceId\": \"34bfcbe116c9407464af37acbaf7a4dc\",\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "fd21306c-96c1-4794-81c0-6bbabe84752c", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"sourceId\": \"34bfcbe116c9407464af37acbaf7a4dc\",\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "04cb32c1-3ec4-4b78-a370-6b6cb5e21c6c", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"sourceId\": \"34bfcbe116c9407464af37acbaf7a4dc\",\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "09ba5394-d4cf-4fff-9fc4-986e88d01883", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"sourceId\": \"34bfcbe116c9407464af37acbaf7a4dc\",\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Account Details", - "id": "c929e6b5-e293-44b5-9d77-7c2d551c7978", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "id": "73f2cb6f-fd0a-4569-b494-f1a9c49b98cc", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "id": "e4907e9c-b336-4018-ada3-43aeb016ce31", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns the details for a single account based on the ID. \nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "65ae3a04-aaf6-4a92-a7bb-6cdc46a16209", - "name": "An account object", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"aName\",\n \"id\": \"id12345\",\n \"created\": \"1989-03-26T22:07:00.449Z\",\n \"modified\": \"2000-05-18T04:45:13.538Z\",\n \"sourceId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"identityId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"attributes\": {},\n \"authoritative\": true,\n \"description\": \"veniam consequat occaecat consectetur elit\",\n \"disabled\": false,\n \"locked\": false,\n \"nativeIdentity\": \"enim mollit et\",\n \"systemAccount\": false,\n \"uncorrelated\": false,\n \"uuid\": \"non ea cupidatat ex\",\n \"manuallyCorrelated\": false,\n \"hasEntitlements\": false\n}" - }, - { - "id": "1bdce11d-da04-4db0-9533-049d42f194fa", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b2aaefb4-c2fe-4059-a85d-262dfc9e3576", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "c527c555-328b-4fbc-b1d9-58909022d2bc", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b5221108-59f3-495a-bf07-a1f59f6477e4", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "10abc692-2382-4a32-856d-6b9153c665a7", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "6aedaff1-47d8-4a86-9739-6e6f001377c2", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Account", - "id": "78799d8f-5da7-4322-a078-7b8763c47784", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "id": "462bca99-ef3c-4988-abe0-905fba852e15", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "id": "31f9a42d-ff77-4926-a928-19fafe9c97cc", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Use this API to modify the following fields:\n* `identityId`\n\n* `manuallyCorrelated`\n\n>**NOTE: All other fields can not be modified.**\n\nThe request must provide a JSONPatch payload.\n\nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "9e555f7d-b54d-4574-9ea0-3f082403ea77", - "name": "Accepted. Update request accepted and is in progress.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{}" - }, - { - "id": "685e68d0-33f6-465c-81f2-e63d4c85f7a4", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "838ee6d7-08f1-457b-953a-7fc7d92a2ff9", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "38386860-c017-4940-9339-23a8df44ff08", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "9a3bd121-2f63-4333-86ec-b08f9a770fe7", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "d2bbe7c2-92b5-4f30-8bbd-2c737214005a", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "8a3f60c4-b373-4ea4-80b6-3106a626b175", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Account", - "id": "42917cc0-63c0-4e4b-b4a7-763d0d87a673", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "id": "57785a29-05bb-494c-9061-993869bf8979", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "id": "089990f9-ac71-40aa-b79a-25157ebb60c4", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API submits an account update task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.\n>**NOTE: The PUT Account API is designated only for Delimited File sources.**" - }, - "response": [ - { - "id": "ac1a05d1-d050-4881-b579-68a7ebe1ad92", - "name": "Async task details", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808474683da6017468693c260195\"\n}" - }, - { - "id": "113b6b20-fa97-40f6-9206-e91d11a4c27f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0352d71d-bc93-4e2e-96f6-36417e830218", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "b43cc64a-eabf-48fa-a61f-a113e62ea1ab", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "d3bf4365-30f3-4a43-8674-4c7b331c9d69", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "3267523d-510d-4561-91ff-79e01e3742d2", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "7c4bd281-a32b-4e32-9d68-f53fd0894db6", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"city\": \"Austin\",\n \"displayName\": \"John Doe\",\n \"userName\": \"jdoe\",\n \"sAMAccountName\": \"jDoe\",\n \"mail\": \"john.doe@sailpoint.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Account", - "id": "c4a166d4-33a1-42cc-ae88-423adab00bdc", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "id": "4b50cfb6-dfff-4162-bab9-b5e56a37a2aa", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "id": "5b881451-6483-41bc-bc9b-56598f21ea17", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API submits an account delete task and returns the task ID. This operation can only be used on Flat File Sources. Any attempt to execute this request on the source of other type will result in an error response with a status code of 400.\nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "7bbe1295-3a44-460f-87b2-bd3581855fef", - "name": "Async task details", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808474683da6017468693c260195\"\n}" - }, - { - "id": "1c6a83eb-9fa0-43b3-90ce-a9a85278ed3e", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "91517c3b-bfe1-4ff5-8aad-f5e1f417217a", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "94d661c5-7288-49c0-a11f-c093159fdac1", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "570c4f56-7c84-4d00-af19-ef97a22878ea", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "ebcae022-f317-4dd6-98c4-71c0e192ba96", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "19ba6bab-b1bd-4fcc-9652-def20d8e1b22", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Account Entitlements", - "id": "69c74956-e5bb-4754-8cdf-c2f62626c0f0", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/entitlements?limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "entitlements" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - } - ], - "variable": [ - { - "id": "94bc3c51-857f-46f3-a3b7-ed4dabef5551", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "id": "ad789f91-2504-4db4-80aa-964b873b328c", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns entitlements of the account. \nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "7cbc51d7-cd10-43b2-9064-692e2652bf64", - "name": "An array of account entitlements", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/entitlements?limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "entitlements" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"name\": \"aName\",\n \"id\": \"id12345\",\n \"created\": \"1985-06-13T05:22:38.764Z\",\n \"modified\": \"2007-06-11T20:34:39.479Z\",\n \"attribute\": \"authorizationType\",\n \"value\": \"CN=Users,dc=sailpoint,dc=com\",\n \"description\": \"non ullamco sint\",\n \"attributes\": {},\n \"sourceSchemaObjectType\": \"group\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"source\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n },\n {\n \"name\": \"aName\",\n \"id\": \"id12345\",\n \"created\": \"1960-03-05T00:33:03.337Z\",\n \"modified\": \"2014-01-11T00:56:34.971Z\",\n \"attribute\": \"authorizationType\",\n \"value\": \"CN=Users,dc=sailpoint,dc=com\",\n \"description\": \"laborum Lorem pariatur amet\",\n \"attributes\": {},\n \"sourceSchemaObjectType\": \"group\",\n \"privileged\": true,\n \"cloudGoverned\": false,\n \"source\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n }\n]" - }, - { - "id": "6e2b0c7a-a853-405f-a12f-f878601a863d", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/entitlements?limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "entitlements" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b8162c9e-b5ca-4e4f-ad83-4d72000d0017", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/entitlements?limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "entitlements" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "f99a0357-9ff9-4aa1-b5df-f0b55b059139", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/entitlements?limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "entitlements" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "e8c273f9-ee7d-44aa-adf6-25d3dda43496", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/entitlements?limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "entitlements" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "5c5d7e32-f69d-4f39-880d-84b351282e41", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/entitlements?limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "entitlements" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "d2692c83-878e-47fa-8622-3acc99e4ff05", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/entitlements?limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "entitlements" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Reload Account", - "id": "fc8e2dd6-06ec-45d4-a850-f98e38a9ecee", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/reload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "reload" - ], - "variable": [ - { - "id": "e8b64e63-925d-4e27-b60b-c7d42a9a895e", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "id": "22714a04-6b54-4264-af6b-3dcbf7b48bcc", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. \nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "9a5efe72-83b6-448e-a336-17c3320025c9", - "name": "Async task details", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/reload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "reload" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808474683da6017468693c260195\"\n}" - }, - { - "id": "3db6e2ed-70ee-48a7-9b0f-d1885fc72031", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/reload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "reload" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "d13708a3-a875-4a5c-af44-b50f94f155aa", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/reload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "reload" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "1e8ee4b4-c1b8-4982-8dbb-085f2d120edf", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/reload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "reload" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "59e01c3c-6cc3-47f4-af1b-9b7a809dfe7c", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/reload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "reload" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "53dab5c5-d545-4a57-99da-d7b8dfb86f81", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/reload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "reload" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "2e981c68-747b-4936-8e55-e0925b5ce984", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/accounts/:id/reload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "reload" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Enable Account", - "id": "7655fd87-2c07-4d5a-8ff5-f592abf56c2f", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/enable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "enable" - ], - "variable": [ - { - "id": "612e0b3b-5bd2-437e-b59c-b67992c80c80", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "id": "37324053-ba3e-4d88-af2a-e20775ccb356", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API submits a task to enable account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "f4e7f0dc-d972-42d6-9846-b7b6e941daeb", - "name": "Async task details", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/enable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "enable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808474683da6017468693c260195\"\n}" - }, - { - "id": "5561972d-fde8-42a9-a531-4de4d59946e7", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/enable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "enable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "f02008ee-a4bb-4c98-8d09-b5aec1a713e7", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/enable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "enable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "f752815b-e399-436a-819d-b944218c534b", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/enable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "enable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b5973c44-4914-4bb7-8c66-a6b9e379fc54", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/enable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "enable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "af3d8d93-5a88-41ab-bfb0-cb07e75a5721", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/enable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "enable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c5ecc22e-0f51-4c62-acfc-b131c914d427", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/enable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "enable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Disable Account", - "id": "8491bb21-8dd2-459f-afb1-e7416519fade", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "disable" - ], - "variable": [ - { - "id": "791192f4-eb28-42cc-bc4c-e748e86f72fb", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "id": "f284b534-67f9-4e1a-a5a2-a96bedb0bb08", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API submits a task to disable the account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "20c5a853-b325-4006-b668-5f79d1d62b1e", - "name": "Async task details", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "disable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808474683da6017468693c260195\"\n}" - }, - { - "id": "ba2c280e-8683-4f93-924f-8cad9b422aad", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "disable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "81c7b97a-676b-478a-bc45-5ed353992ceb", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "disable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "cabe6786-19bc-4060-9f75-e3568858401e", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "disable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "d3214a15-37b1-454a-908c-bce3341f5983", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "disable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "038bdead-5f35-4b1f-bfae-c7245cb4285a", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "disable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "96ef3cb9-f0e5-40d4-9eb1-2407e10add60", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "disable" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Unlock Account", - "id": "1348c343-8842-47c7-b189-ec280e0bd314", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"unlockIDNAccount\": false,\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/unlock", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "unlock" - ], - "variable": [ - { - "id": "f7ec3d06-b93d-4535-9073-b3d777da2ee9", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "id": "1ec48c6d-6e4e-4f42-ba09-06a5f03494cd", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API submits a task to unlock an account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "4afde499-5ddd-4845-8942-debd2b723169", - "name": "Async task details", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"unlockIDNAccount\": false,\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/unlock", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "unlock" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808474683da6017468693c260195\"\n}" - }, - { - "id": "03c343bc-3400-41a2-a20f-97e895c8d028", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"unlockIDNAccount\": false,\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/unlock", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "unlock" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "dc86ec25-adc6-42ec-8991-8baa09d965a9", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"unlockIDNAccount\": false,\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/unlock", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "unlock" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "d6d11ce8-b697-4624-8b7e-5ba9a056da57", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"unlockIDNAccount\": false,\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/unlock", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "unlock" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "46f7c400-8a41-478f-8af1-3f9dacc52dcd", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"unlockIDNAccount\": false,\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/unlock", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "unlock" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "216f2199-5be6-4a71-8c2f-8275428adff3", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"unlockIDNAccount\": false,\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/unlock", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "unlock" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "1fb3b1d2-dd74-4173-932b-81c7b6b15090", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"externalVerificationId\": \"3f9180835d2e5168015d32f890ca1581\",\n \"unlockIDNAccount\": false,\n \"forceProvisioning\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accounts/:id/unlock", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accounts", - ":id", - "unlock" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "76b2894a-7b03-4bc4-bfb6-096e7f87cba3", - "description": "Use this API to implement and customize account functionality.\nWith this functionality in place, administrators can manage users' access across sources in IdentityNow. \n\nIn IdentityNow, an account refers to a user's account on a supported source.\nThis typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. IdentityNow loads accounts through the creation of sources in IdentityNow.\n\nAdministrators can correlate users' identities with the users' accounts on the different sources they use. \nThis allows IdentityNow to govern the access of identities and all their correlated accounts securely and cohesively. \n\nTo view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. \n\nTo view and edit source account statuses for an identity in IdentityNow, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. \nAdministrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. \n\nAccounts can have the following statuses: \n\n- Enabled: The account is enabled. The user can access it.\n\n- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in IdentityNow. This can occur when an administrator disables the account or when the user's lifecycle state changes. \n\n- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times.\n\n- Pending: The account is currently updating. This status typically lasts seconds. \n\nAdministrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed.\n\nRefer to the following link for more information about accounts:\n" - }, - { - "name": "Account Activities", - "item": [ - { - "name": "Get a list of Account Activities", - "id": "9a6fafda-f4c6-4155-9d32-0462d9dcaf2c", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities?requested-for=eu&requested-by=eu®arding-identity=eu&type=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities" - ], - "query": [ - { - "key": "requested-for", - "value": "eu", - "description": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*." - }, - { - "key": "requested-by", - "value": "eu", - "description": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*." - }, - { - "key": "regarding-identity", - "value": "eu", - "description": "The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*." - }, - { - "key": "type", - "value": "eu", - "description": "The type of account activity." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**type**: *eq, in*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*" - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **type, created, modified**" - } - ], - "variable": [ - { - "id": "de2ec662-d570-44df-b658-ccdd6f4f829f", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a collection of account activities that satisfy the given query parameters." - }, - "response": [ - { - "id": "fabf972a-36b3-4f08-aa55-5043f2b48b6b", - "name": "List of account activities", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities?requested-for=eu&requested-by=eu®arding-identity=eu&type=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "requested-by", - "value": "eu" - }, - { - "key": "regarding-identity", - "value": "eu" - }, - { - "key": "type", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"2c9180835d2e5168015d32f890ca1581\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"completionStatus\": \"FAILURE\",\n \"type\": \"appRequest\",\n \"requesterIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": false\n },\n \"targetIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"errors\": [\n \"sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.\"\n ],\n \"warnings\": [\n \"Some warning, another warning\"\n ],\n \"items\": [\n {\n \"id\": \"2725138ee34949beb0d6cc982d2d4625\",\n \"name\": \"id enim culpa\",\n \"requested\": \"2017-07-11T18:45:37.098Z\",\n \"approvalStatus\": \"EXPIRED\",\n \"provisioningStatus\": \"UNVERIFIABLE\",\n \"requesterComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"reviewerComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"operation\": \"DELETE\",\n \"attribute\": \"detectedRoles\",\n \"value\": \"Treasury Analyst [AccessProfile-1529010191212]\",\n \"nativeIdentity\": \"Sandie.Camero\",\n \"sourceId\": \"2c91808363ef85290164000587130c0c\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"2c91808563ef85690164001c31140c0c\",\n \"requestedObjectName\": \"Treasury Analyst\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"ut770\": \"ut\",\n \"et_9\": \"deserunt voluptate\",\n \"non995\": \"nisi ipsum\"\n },\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n },\n {\n \"id\": \"2725138ee34949beb0d6cc982d2d4625\",\n \"name\": \"veniam ut aute\",\n \"requested\": \"2017-07-11T18:45:37.098Z\",\n \"approvalStatus\": \"FINISHED\",\n \"provisioningStatus\": \"COMMITED\",\n \"requesterComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"reviewerComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"operation\": \"REMOVE\",\n \"attribute\": \"detectedRoles\",\n \"value\": \"Treasury Analyst [AccessProfile-1529010191212]\",\n \"nativeIdentity\": \"Sandie.Camero\",\n \"sourceId\": \"2c91808363ef85290164000587130c0c\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"2c91808563ef85690164001c31140c0c\",\n \"requestedObjectName\": \"Treasury Analyst\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"anim_b8\": \"enim consequat\",\n \"aliqua3\": \"ut\"\n },\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n }\n ],\n \"executionStatus\": \"COMPLETED\",\n \"clientMetadata\": {\n \"reprehenderit_dd\": \"ex dolore cupidatat cillum\",\n \"exercitation_ddc\": \"incididunt et veniam non ullamco\"\n }\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"2c9180835d2e5168015d32f890ca1581\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"completionStatus\": \"INCOMPLETE\",\n \"type\": \"appRequest\",\n \"requesterIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": false\n },\n \"targetIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": false\n },\n \"errors\": [\n \"sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.\"\n ],\n \"warnings\": [\n \"Some warning, another warning\"\n ],\n \"items\": [\n {\n \"id\": \"2725138ee34949beb0d6cc982d2d4625\",\n \"name\": \"laborum occaecat esse do\",\n \"requested\": \"2017-07-11T18:45:37.098Z\",\n \"approvalStatus\": \"REJECTED\",\n \"provisioningStatus\": \"PENDING\",\n \"requesterComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"reviewerComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"operation\": \"UNLOCK\",\n \"attribute\": \"detectedRoles\",\n \"value\": \"Treasury Analyst [AccessProfile-1529010191212]\",\n \"nativeIdentity\": \"Sandie.Camero\",\n \"sourceId\": \"2c91808363ef85290164000587130c0c\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"2c91808563ef85690164001c31140c0c\",\n \"requestedObjectName\": \"Treasury Analyst\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"auted0\": \"ut ad culpa sunt\"\n },\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n },\n {\n \"id\": \"2725138ee34949beb0d6cc982d2d4625\",\n \"name\": \"voluptate dolore velit\",\n \"requested\": \"2017-07-11T18:45:37.098Z\",\n \"approvalStatus\": \"EXPIRED\",\n \"provisioningStatus\": \"RETRY\",\n \"requesterComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"reviewerComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"operation\": \"LOCK\",\n \"attribute\": \"detectedRoles\",\n \"value\": \"Treasury Analyst [AccessProfile-1529010191212]\",\n \"nativeIdentity\": \"Sandie.Camero\",\n \"sourceId\": \"2c91808363ef85290164000587130c0c\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"2c91808563ef85690164001c31140c0c\",\n \"requestedObjectName\": \"Treasury Analyst\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"cupidatat_6\": \"ullamco laboris commodo Lorem\",\n \"tempordc9\": \"Excepteur in\"\n },\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n }\n ],\n \"executionStatus\": \"TERMINATED\",\n \"clientMetadata\": {\n \"aute_e\": \"esse Duis pariatur\"\n }\n }\n]" - }, - { - "id": "2a686c9a-ee3b-4e79-9bad-cee378418f35", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities?requested-for=eu&requested-by=eu®arding-identity=eu&type=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "requested-by", - "value": "eu" - }, - { - "key": "regarding-identity", - "value": "eu" - }, - { - "key": "type", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e8738962-c9a9-4185-9af5-2101e9ad7b6c", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities?requested-for=eu&requested-by=eu®arding-identity=eu&type=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "requested-by", - "value": "eu" - }, - { - "key": "regarding-identity", - "value": "eu" - }, - { - "key": "type", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "feb871cb-958e-4f86-97c7-86cfed136ba2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities?requested-for=eu&requested-by=eu®arding-identity=eu&type=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "requested-by", - "value": "eu" - }, - { - "key": "regarding-identity", - "value": "eu" - }, - { - "key": "type", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "9316fd34-c8ae-4f18-81c5-2230e99045ff", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities?requested-for=eu&requested-by=eu®arding-identity=eu&type=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "requested-by", - "value": "eu" - }, - { - "key": "regarding-identity", - "value": "eu" - }, - { - "key": "type", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "73e76a9d-4a31-48c2-bf56-ad16460d8945", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities?requested-for=eu&requested-by=eu®arding-identity=eu&type=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "requested-by", - "value": "eu" - }, - { - "key": "regarding-identity", - "value": "eu" - }, - { - "key": "type", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get an Account Activity", - "id": "45bb70ce-884c-4920-b37d-4d3e85f63f9d", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities", - ":id" - ], - "variable": [ - { - "id": "b8cbfe48-8698-453e-83cc-0c37c5570e3c", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account activity id" - }, - { - "id": "61ffa4fa-e711-4463-bb00-5f75808aeaae", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a single account activity by its id." - }, - "response": [ - { - "id": "d788ae9a-da40-4bdf-9164-8978b095328d", - "name": "An account activity object", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account activity id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"2c9180835d2e5168015d32f890ca1581\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"completionStatus\": \"PENDING\",\n \"type\": \"appRequest\",\n \"requesterIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": false\n },\n \"targetIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": false\n },\n \"errors\": [\n \"sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.\"\n ],\n \"warnings\": [\n \"Some warning, another warning\"\n ],\n \"items\": [\n {\n \"id\": \"2725138ee34949beb0d6cc982d2d4625\",\n \"name\": \"magna do sunt\",\n \"requested\": \"2017-07-11T18:45:37.098Z\",\n \"approvalStatus\": \"RETURNED\",\n \"provisioningStatus\": \"FINISHED\",\n \"requesterComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": false\n },\n \"reviewerComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"operation\": \"UNLOCK\",\n \"attribute\": \"detectedRoles\",\n \"value\": \"Treasury Analyst [AccessProfile-1529010191212]\",\n \"nativeIdentity\": \"Sandie.Camero\",\n \"sourceId\": \"2c91808363ef85290164000587130c0c\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"2c91808563ef85690164001c31140c0c\",\n \"requestedObjectName\": \"Treasury Analyst\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"exercitationfa5\": \"exercitation nostrud\",\n \"proidentc8\": \"dolore\"\n },\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n },\n {\n \"id\": \"2725138ee34949beb0d6cc982d2d4625\",\n \"name\": \"aute nisi ea adipisicing\",\n \"requested\": \"2017-07-11T18:45:37.098Z\",\n \"approvalStatus\": \"PENDING\",\n \"provisioningStatus\": \"COMMITED\",\n \"requesterComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"reviewerComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"operation\": \"ADD\",\n \"attribute\": \"detectedRoles\",\n \"value\": \"Treasury Analyst [AccessProfile-1529010191212]\",\n \"nativeIdentity\": \"Sandie.Camero\",\n \"sourceId\": \"2c91808363ef85290164000587130c0c\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"2c91808563ef85690164001c31140c0c\",\n \"requestedObjectName\": \"Treasury Analyst\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"fugiat__\": \"nostrud nisi\"\n },\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n }\n ],\n \"executionStatus\": \"TERMINATED\",\n \"clientMetadata\": {\n \"ea54\": \"nulla proident est\"\n }\n}" - }, - { - "id": "42351cf0-232d-40e9-833b-7cc7ce9ba0a0", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account activity id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "73ec0c46-be7a-485e-8cd2-77be69b648b7", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account activity id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "b68d2ad8-710e-487e-9f0a-139abc302bc3", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account activity id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "616e902e-206e-4672-bfc0-fcf7b6f5bccb", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account activity id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "32e0eaac-69c0-4f51-a1e6-f8ca4a9c1da0", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account activity id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "bf3239da-4f86-49dc-97dc-017d05e169b2", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/account-activities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "account-activities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The account activity id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "a0a98c6b-9c20-4bb3-83ee-84b17f776e19", - "description": "Use this API to implement account activity tracking functionality.\nWith this functionality in place, users can track source account activity in IdentityNow, which greatly improves traceability in the system. \n\nAn account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. \nIn IdentityNow's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. \n\nAccount activity includes most actions IdentityNow completes on source accounts. Users can search in IdentityNow for the following account action types: \n\n- Access Request: These include any access requests the source account is involved in. \n\n- Account Attribute Updates: These include updates to a single attribute on an account on a source. \n\n- Account State Update: These include locking or unlocking actions on an account on a source. \n\n- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification.\n\n- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. \nIdentityNow replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. \n\n- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. \nWhen you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays.\nAccount Activity does not include attribute updates that occur as a result of aggregation.\n\n- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. \nThese also include refreshes that occur whenever IdentityNow assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. \n\n- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. \n\n- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state.\n\n- Password Change: These include password changes on sources.\n\nRefer to the following link for more information about account activities:\n" - }, - { - "name": "Certifications", - "item": [ - { - "name": "Identity Campaign Certifications by IDs", - "id": "bf5ad4ae-ff36-4b06-84ab-6f51a1af6fc7", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications?reviewer-identity=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications" - ], - "query": [ - { - "key": "reviewer-identity", - "value": "eu", - "description": "The ID of reviewer identity. *me* indicates the current user." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**id**: *eq, in*\n**campaign.id**: *eq, in*\n**phase**: *eq*\n**completed**: *eq, ne*" - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **name, due, signed**" - } - ], - "variable": [ - { - "id": "9c45d610-561f-4fa2-8ced-6bfe4cfab2c4", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns a list of identity campaign certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to Governance Groups." - }, - "response": [ - { - "id": "29304e0e-b33e-4d81-9145-89993be28317", - "name": "List of identity campaign certifications", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications?reviewer-identity=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications" - ], - "query": [ - { - "key": "reviewer-identity", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Source Owner Access Review for Employees [source]\",\n \"campaign\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Campaign Name\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"A description of the campaign\"\n },\n \"completed\": true,\n \"identitiesCompleted\": 5,\n \"identitiesTotal\": 10,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"decisionsMade\": 20,\n \"decisionsTotal\": 40,\n \"due\": \"2018-10-19T13:49:37.385Z\",\n \"signed\": \"2018-10-19T13:49:37.385Z\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Certification Name\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n }\n },\n \"comment\": \"Reassigned for a reason\"\n },\n \"hasErrors\": false,\n \"errorMessage\": \"The certification has an error\",\n \"phase\": \"ACTIVE\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Source Owner Access Review for Employees [source]\",\n \"campaign\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Campaign Name\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"A description of the campaign\"\n },\n \"completed\": true,\n \"identitiesCompleted\": 5,\n \"identitiesTotal\": 10,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"decisionsMade\": 20,\n \"decisionsTotal\": 40,\n \"due\": \"2018-10-19T13:49:37.385Z\",\n \"signed\": \"2018-10-19T13:49:37.385Z\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Certification Name\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n }\n },\n \"comment\": \"Reassigned for a reason\"\n },\n \"hasErrors\": false,\n \"errorMessage\": \"The certification has an error\",\n \"phase\": \"ACTIVE\"\n }\n]" - }, - { - "id": "74744073-e9c2-45c4-8c25-337e791cd10e", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications?reviewer-identity=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications" - ], - "query": [ - { - "key": "reviewer-identity", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b29930f9-dfca-4020-bddc-f9d3ada7b6e5", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications?reviewer-identity=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications" - ], - "query": [ - { - "key": "reviewer-identity", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "bb44630e-b250-431f-baeb-55c0d43fe7d7", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications?reviewer-identity=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications" - ], - "query": [ - { - "key": "reviewer-identity", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "a8f2fca8-0919-41ea-afe3-e5575f8f13e0", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications?reviewer-identity=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications" - ], - "query": [ - { - "key": "reviewer-identity", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "daac7e0e-5a9f-4c3d-b666-feb8b7cae84e", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications?reviewer-identity=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications" - ], - "query": [ - { - "key": "reviewer-identity", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Identity Certification by ID", - "id": "a6fbb5a1-6904-476c-bff7-c9cf701c1d89", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id" - ], - "variable": [ - { - "id": "982c79bf-519b-4b66-b182-039c0cb89533", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification id" - }, - { - "id": "424c3484-1b1b-4412-9386-3d2f42dac073", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups." - }, - "response": [ - { - "id": "f74e7c5a-3358-461c-8c7d-0816ab591e54", - "name": "An identity campaign certification object", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Source Owner Access Review for Employees [source]\",\n \"campaign\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Campaign Name\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"A description of the campaign\"\n },\n \"completed\": true,\n \"identitiesCompleted\": 5,\n \"identitiesTotal\": 10,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"decisionsMade\": 20,\n \"decisionsTotal\": 40,\n \"due\": \"2018-10-19T13:49:37.385Z\",\n \"signed\": \"2018-10-19T13:49:37.385Z\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Certification Name\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n }\n },\n \"comment\": \"Reassigned for a reason\"\n },\n \"hasErrors\": false,\n \"errorMessage\": \"The certification has an error\",\n \"phase\": \"ACTIVE\"\n}" - }, - { - "id": "754fb11e-5498-4b57-ad27-ff2713593a4e", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "6f71dd86-3ec8-473d-828e-90f924c7893f", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "80a21abb-5323-4437-bb30-9c423669ee03", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "86982a37-2f09-4045-99c9-ba2796700e5f", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "5f675842-1f9d-4de8-95ea-5cbab1448c5b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "5622655f-fd81-4efd-a2a5-d9960d43b2c2", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "List of Access Review Items", - "id": "57040fef-1d93-40a2-8e22-556e86ab3440", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-review-items?limit=250&offset=0&count=true&filters=eu&sorters=eu&entitlements=eu&access-profiles=eu&roles=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-review-items" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**type / access.type**: *eq*\n\n**completed**: *eq, ne*\n\n**identitySummary.id**: *eq, in*\n\n**identitySummary.name**: *eq, sw*\n\n**access.id**: *eq, in*\n\n**access.name**: *eq, sw*\n\n**entitlement.sourceName**: *eq, sw*\n\n**accessProfile.sourceName**: *eq, sw*" - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName**" - }, - { - "key": "entitlements", - "value": "eu", - "description": "Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs.\n\nAn error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time." - }, - { - "key": "access-profiles", - "value": "eu", - "description": "Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs.\n\nAn error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time." - }, - { - "key": "roles", - "value": "eu", - "description": "Filter results to view access review items that pertain to any of the specified comma-separated role IDs.\n\nAn error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time." - } - ], - "variable": [ - { - "id": "59e1aa92-53c2-44cc-b48e-fa5fa15c50d0", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "id": "e0b4946d-37d9-456c-9843-0dbe78dddc62", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups." - }, - "response": [ - { - "id": "8433d7e7-3736-4324-b901-0b40b656949d", - "name": "A list of access review items", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-review-items?limit=250&offset=0&count=true&filters=eu&sorters=eu&entitlements=eu&access-profiles=eu&roles=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-review-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "entitlements", - "value": "eu" - }, - { - "key": "access-profiles", - "value": "eu" - }, - { - "key": "roles", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"accessSummary\": {\n \"access\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180867160846801719932c5153fb7\",\n \"name\": \"Entitlement for Company Database\"\n },\n \"entitlement\": {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"do deserunt\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n },\n \"accessProfile\": {\n \"id\": \"2c91808a7190d06e01719938fcd20792\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"Collection of entitlements to read/write the employee database\",\n \"privileged\": false,\n \"cloudGoverned\": true,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": true,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"nostrud dolor\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n },\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"laborum Duis minim Excepteur aliqua\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n }\n ],\n \"created\": \"2021-01-01T22:32:58.104Z\",\n \"modified\": \"2021-02-01T22:32:58.104Z\"\n },\n \"role\": {\n \"id\": \"2c91808a7190d06e0171993907fd0794\",\n \"name\": \"Accounting-Employees\",\n \"description\": \"Role for members of the accounting department with the necessary Access Profiles\",\n \"privileged\": true,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"revocable\": true,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"accessProfiles\": [\n {\n \"id\": \"2c91808a7190d06e01719938fcd20792\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"Collection of entitlements to read/write the employee database\",\n \"privileged\": false,\n \"cloudGoverned\": true,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"nulla irure voluptate eu ea\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n },\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": true,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"minim do\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n }\n ],\n \"created\": \"2021-01-01T22:32:58.104Z\",\n \"modified\": \"2021-02-01T22:32:58.104Z\"\n },\n {\n \"id\": \"2c91808a7190d06e01719938fcd20792\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"Collection of entitlements to read/write the employee database\",\n \"privileged\": true,\n \"cloudGoverned\": true,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": true,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"adipisicing sit ipsum mollit\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n },\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"cupidatat et deserunt sed\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n }\n ],\n \"created\": \"2021-01-01T22:32:58.104Z\",\n \"modified\": \"2021-02-01T22:32:58.104Z\"\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"2c91808772a504f50172a9540e501ba7\",\n \"name\": \"Alison Ferguso\",\n \"identityId\": \"2c9180857182306001719937377a33de\",\n \"completed\": true\n },\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"completed\": false,\n \"newAccess\": false,\n \"decision\": \"APPROVE\",\n \"comments\": \"This user still needs access to this source\"\n },\n {\n \"accessSummary\": {\n \"access\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180867160846801719932c5153fb7\",\n \"name\": \"Entitlement for Company Database\"\n },\n \"entitlement\": {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"ipsum ex tempor\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n },\n \"accessProfile\": {\n \"id\": \"2c91808a7190d06e01719938fcd20792\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"Collection of entitlements to read/write the employee database\",\n \"privileged\": false,\n \"cloudGoverned\": true,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"reprehenderit laborum\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n },\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"adipisicing consequat laboris\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n }\n ],\n \"created\": \"2021-01-01T22:32:58.104Z\",\n \"modified\": \"2021-02-01T22:32:58.104Z\"\n },\n \"role\": {\n \"id\": \"2c91808a7190d06e0171993907fd0794\",\n \"name\": \"Accounting-Employees\",\n \"description\": \"Role for members of the accounting department with the necessary Access Profiles\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"revocable\": true,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"accessProfiles\": [\n {\n \"id\": \"2c91808a7190d06e01719938fcd20792\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"Collection of entitlements to read/write the employee database\",\n \"privileged\": false,\n \"cloudGoverned\": true,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": true,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"enim sint do\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n },\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": true,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"mollit ad\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n }\n ],\n \"created\": \"2021-01-01T22:32:58.104Z\",\n \"modified\": \"2021-02-01T22:32:58.104Z\"\n },\n {\n \"id\": \"2c91808a7190d06e01719938fcd20792\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"Collection of entitlements to read/write the employee database\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": true,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"inci\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n },\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": true,\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"magna laborum\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\"\n }\n }\n ],\n \"created\": \"2021-01-01T22:32:58.104Z\",\n \"modified\": \"2021-02-01T22:32:58.104Z\"\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"2c91808772a504f50172a9540e501ba7\",\n \"name\": \"Alison Ferguso\",\n \"identityId\": \"2c9180857182306001719937377a33de\",\n \"completed\": false\n },\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"completed\": false,\n \"newAccess\": true,\n \"decision\": \"APPROVE\",\n \"comments\": \"This user still needs access to this source\"\n }\n]" - }, - { - "id": "1d113707-1080-4cd8-9de7-7a875569faa6", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-review-items?limit=250&offset=0&count=true&filters=eu&sorters=eu&entitlements=eu&access-profiles=eu&roles=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-review-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "entitlements", - "value": "eu" - }, - { - "key": "access-profiles", - "value": "eu" - }, - { - "key": "roles", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "96bc4e02-4a6a-4298-8e23-c823d9ecfbb1", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-review-items?limit=250&offset=0&count=true&filters=eu&sorters=eu&entitlements=eu&access-profiles=eu&roles=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-review-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "entitlements", - "value": "eu" - }, - { - "key": "access-profiles", - "value": "eu" - }, - { - "key": "roles", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b02149cd-9886-4b4a-b3b1-f536fbe42a7d", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-review-items?limit=250&offset=0&count=true&filters=eu&sorters=eu&entitlements=eu&access-profiles=eu&roles=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-review-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "entitlements", - "value": "eu" - }, - { - "key": "access-profiles", - "value": "eu" - }, - { - "key": "roles", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "0580733a-0320-43e9-9377-659f4813f678", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-review-items?limit=250&offset=0&count=true&filters=eu&sorters=eu&entitlements=eu&access-profiles=eu&roles=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-review-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "entitlements", - "value": "eu" - }, - { - "key": "access-profiles", - "value": "eu" - }, - { - "key": "roles", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "b88a48a8-6fe2-4772-a540-f7d18829ef20", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-review-items?limit=250&offset=0&count=true&filters=eu&sorters=eu&entitlements=eu&access-profiles=eu&roles=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-review-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "entitlements", - "value": "eu" - }, - { - "key": "access-profiles", - "value": "eu" - }, - { - "key": "roles", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Decide on a Certification Item", - "id": "30269e08-104a-4702-8ddd-97af778994b8", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"id\": \"ef38f94347e94562b5bb8424a56396b5\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source.\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source too.\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/decide", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decide" - ], - "variable": [ - { - "id": "66912e1f-9020-464d-8e4f-4684a89a3a30", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the identity campaign certification on which to make decisions" - }, - { - "id": "1c36963c-798b-4bf5-93cb-bbfa430f69cf", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "The API makes a decision to approve or revoke one or more identity campaign certification items. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups." - }, - "response": [ - { - "id": "5235edb3-9bd4-49c0-9b13-9d46f7676177", - "name": "An identity campaign certification object", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"id\": \"ef38f94347e94562b5bb8424a56396b5\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source.\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source too.\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/decide", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decide" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the identity campaign certification on which to make decisions" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Source Owner Access Review for Employees [source]\",\n \"campaign\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Campaign Name\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"A description of the campaign\"\n },\n \"completed\": true,\n \"identitiesCompleted\": 5,\n \"identitiesTotal\": 10,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"decisionsMade\": 20,\n \"decisionsTotal\": 40,\n \"due\": \"2018-10-19T13:49:37.385Z\",\n \"signed\": \"2018-10-19T13:49:37.385Z\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Certification Name\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n }\n },\n \"comment\": \"Reassigned for a reason\"\n },\n \"hasErrors\": false,\n \"errorMessage\": \"The certification has an error\",\n \"phase\": \"ACTIVE\"\n}" - }, - { - "id": "760e3db6-3a0f-4684-a1ae-ee5e4cc761e1", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"id\": \"ef38f94347e94562b5bb8424a56396b5\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source.\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source too.\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/decide", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decide" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the identity campaign certification on which to make decisions" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0e9dde19-68ae-4806-927b-c8f661a30b85", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"id\": \"ef38f94347e94562b5bb8424a56396b5\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source.\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source too.\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/decide", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decide" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the identity campaign certification on which to make decisions" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ea13df84-6c8c-408b-8c02-dec3444f5098", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"id\": \"ef38f94347e94562b5bb8424a56396b5\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source.\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source too.\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/decide", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decide" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the identity campaign certification on which to make decisions" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "730a80e2-0c27-47c1-b66b-7c2185e9807d", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"id\": \"ef38f94347e94562b5bb8424a56396b5\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source.\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source too.\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/decide", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decide" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the identity campaign certification on which to make decisions" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "3c55f266-7d14-4ce2-8455-c7e3912b2f91", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"id\": \"ef38f94347e94562b5bb8424a56396b5\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source.\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source too.\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/decide", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decide" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the identity campaign certification on which to make decisions" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "a04e1eb5-2e49-43e5-beb8-1fde0f507cfc", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"id\": \"ef38f94347e94562b5bb8424a56396b5\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source.\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"decision\": \"APPROVE\",\n \"bulk\": true,\n \"comments\": \"This user still needs access to this source too.\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/decide", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decide" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the identity campaign certification on which to make decisions" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Reassign Identities or Items", - "id": "6b2ec868-8721-49a9-84ba-11f0f614cf90", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"reason\": \"reassigned for some reason\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "reassign" - ], - "variable": [ - { - "id": "191abc53-330d-4d9c-960c-a2c54cfaba96", - "key": "id", - "value": "eu", - "description": "(Required) The identity campaign certification ID" - }, - { - "id": "6ee9df74-4637-4af8-ba02-c1e639f55f0e", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups." - }, - "response": [ - { - "id": "531e911f-4716-414d-b5e4-17ce554d99a8", - "name": "An identity campaign certification details after completing the reassignment.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"TARGET_SUMMARY\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"reason\": \"reassigned for some reason\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "reassign" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Source Owner Access Review for Employees [source]\",\n \"campaign\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Campaign Name\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"A description of the campaign\"\n },\n \"completed\": true,\n \"identitiesCompleted\": 5,\n \"identitiesTotal\": 10,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"decisionsMade\": 20,\n \"decisionsTotal\": 40,\n \"due\": \"2018-10-19T13:49:37.385Z\",\n \"signed\": \"2018-10-19T13:49:37.385Z\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Certification Name\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n }\n },\n \"comment\": \"Reassigned for a reason\"\n },\n \"hasErrors\": false,\n \"errorMessage\": \"The certification has an error\",\n \"phase\": \"ACTIVE\"\n}" - }, - { - "id": "865855cc-7329-49e0-bb4a-faa37430f4df", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"TARGET_SUMMARY\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"reason\": \"reassigned for some reason\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "reassign" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "3825cbce-8bd1-4808-8620-2fa2038603e9", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"TARGET_SUMMARY\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"reason\": \"reassigned for some reason\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "reassign" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "8573dd44-9417-4520-8d5a-fc4927405e50", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"TARGET_SUMMARY\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"reason\": \"reassigned for some reason\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "reassign" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "5f7280e7-4be1-4b20-9829-df35ec3df5c6", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"TARGET_SUMMARY\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"reason\": \"reassigned for some reason\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "reassign" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "6061392a-8bc1-4881-877b-882e980639c3", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"TARGET_SUMMARY\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"reason\": \"reassigned for some reason\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "reassign" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "d191faec-c8a9-44bf-9d15-d6b4b95c2428", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reassign\": [\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"TARGET_SUMMARY\"\n },\n {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"reason\": \"reassigned for some reason\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/certifications/:id/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "reassign" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Finalize Identity Certification Decisions", - "id": "c024fdfc-50a5-4e5a-bed0-954cb6f0f406", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/sign-off", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "sign-off" - ], - "variable": [ - { - "id": "8bfdb0dd-997e-4777-ac3c-8b13142e187a", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "id": "fb601cc5-3c76-40c7-8928-f4f09498b4ab", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups." - }, - "response": [ - { - "id": "e71278e2-58ff-4471-beb6-040323882c84", - "name": "An identity campaign certification object", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/sign-off", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "sign-off" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Source Owner Access Review for Employees [source]\",\n \"campaign\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Campaign Name\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"A description of the campaign\"\n },\n \"completed\": true,\n \"identitiesCompleted\": 5,\n \"identitiesTotal\": 10,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"decisionsMade\": 20,\n \"decisionsTotal\": 40,\n \"due\": \"2018-10-19T13:49:37.385Z\",\n \"signed\": \"2018-10-19T13:49:37.385Z\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Certification Name\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n }\n },\n \"comment\": \"Reassigned for a reason\"\n },\n \"hasErrors\": false,\n \"errorMessage\": \"The certification has an error\",\n \"phase\": \"ACTIVE\"\n}" - }, - { - "id": "0306e6bf-dc68-4f35-949d-2971e0f1750a", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/sign-off", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "sign-off" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e6ffdae5-35f8-48f6-a49a-1b32189ee356", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/sign-off", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "sign-off" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "175ad301-4cf0-4bd1-aff1-6bf5b6630069", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/sign-off", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "sign-off" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "c5390b49-e315-45a8-8ca3-e38da37de659", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/sign-off", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "sign-off" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "3a30f0f5-7358-4b31-a453-87ab09a2772a", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/sign-off", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "sign-off" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "e2818e0b-b1a5-4093-8c51-01567b296c94", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/sign-off", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "sign-off" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "82b71fff-0614-456a-a498-b4602c6131a9", - "description": "Use this API to implement certification functionality. \nWith this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. \nImplementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. \n\nA certification refers to IdentityNow's mechanism for reviewing user's access to entitlements (sets of permissions) and approving or removing that access. \nThese serve as a way of showing that a user's access has been reviewed and approved. \nMultiple certifications by different reviewers are often required to approve a user's access. \nA set of multiple certifications is called a certification campaign.\n\nFor example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by his or her manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. \nOnce this certification has been completed, IdentityNow would provision all the access the user needs, nothing more. \n\nOrganization administrators or certification administrators can designate other IdentityNow users as certification reviewers. \nThose reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. \n\nWhen a certification campaign is in progress,certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. \nUnder the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. \n\nOnce a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process.\nDoing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. \n\nOnce all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation.\nIn this situation, the certification campaign completes once all the remediation requests are completed. \n\nRefer to the following link for more information about certifications: \n" - }, - { - "name": "Certification Summaries", - "item": [ - { - "name": "Summary of Certification Decisions", - "id": "544b93ea-2fad-4391-9a26-21b6c77d99e2", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/decision-summary?filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decision-summary" - ], - "query": [ - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407)\n\nFiltering is supported for the following fields and operators:\n\n**identitySummary.id**: *eq, in*" - } - ], - "variable": [ - { - "id": "7f139aa2-b9a3-49b4-8db6-1a4762f1d453", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification ID" - }, - { - "id": "983c31ca-f2df-4ddc-9d3e-d98d74fffe10", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API." - }, - "response": [ - { - "id": "e7cefcab-17a4-4b1c-9bee-4a6a119a73ed", - "name": "Summary of the decisions made", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/decision-summary?filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decision-summary" - ], - "query": [ - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"entitlementDecisionsMade\": 3,\n \"accessProfileDecisionsMade\": 5,\n \"roleDecisionsMade\": 2,\n \"accountDecisionsMade\": 4,\n \"entitlementDecisionsTotal\": 6,\n \"accessProfileDecisionsTotal\": 10,\n \"roleDecisionsTotal\": 4,\n \"accountDecisionsTotal\": 8,\n \"entitlementsApproved\": 2,\n \"entitlementsRevoked\": 1,\n \"accessProfilesApproved\": 3,\n \"accessProfilesRevoked\": 2,\n \"rolesApproved\": 2,\n \"rolesRevoked\": 0,\n \"accountsApproved\": 1,\n \"accountsRevoked\": 3\n}" - }, - { - "id": "c36dd95c-12c2-46aa-89f8-8500186d295f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/decision-summary?filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decision-summary" - ], - "query": [ - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "eaaf912d-7858-4b47-8a6a-38b132dace0e", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/decision-summary?filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decision-summary" - ], - "query": [ - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "694e8ffd-0592-46d6-a74a-0cac2a60f5f8", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/decision-summary?filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decision-summary" - ], - "query": [ - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "e9fd85bc-e8e8-429d-8934-0423b16a525f", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/decision-summary?filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decision-summary" - ], - "query": [ - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "65d0a082-91e1-4a02-b031-177549bda14f", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/decision-summary?filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decision-summary" - ], - "query": [ - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "6f7c1d79-5e9e-41e9-a346-02c06f89081c", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/decision-summary?filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "decision-summary" - ], - "query": [ - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Identity Summaries for Identity Campaign Certification", - "id": "27e60275-b586-4df0-97f0-ded0d772fb04", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summaries?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summaries" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**completed**: *eq, ne*\n\n**name**: *eq, sw*" - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**" - } - ], - "variable": [ - { - "id": "0b63f0f8-bd76-4ec7-92df-08b17177fe07", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "id": "a4d21f56-d2a8-40c4-91a2-af6a3d8fff41", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns a list of the identity summaries for a specific identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API." - }, - "response": [ - { - "id": "db382eea-cca1-4882-b87d-9822bd9cc2f9", - "name": "List of identity summaries", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summaries?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summaries" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c91808772a504f50172a9540e501ba7\",\n \"name\": \"Aaron Grey\",\n \"identityId\": \"2c9180857182306001719937379633e4\",\n \"completed\": false\n },\n {\n \"id\": \"2c91808772a504f50172a9540e501ba8\",\n \"name\": \"Aglae Wilson\",\n \"identityId\": \"2c9180857182306001719937377a33de\",\n \"completed\": true\n }\n]" - }, - { - "id": "3a172197-f3a5-4590-9b1e-7116192f7159", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summaries?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summaries" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "709faafb-9488-40c1-be55-68b76bbeb1fb", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summaries?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summaries" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "c99ed591-3f8d-4fc3-acde-2e158c3632f8", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summaries?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summaries" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "6ca90ffe-2192-45e6-95f9-14a401df3017", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summaries?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summaries" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "5905d97e-f1bf-4118-ac78-816dee93d284", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summaries?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summaries" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "4703c511-6321-419b-9768-c38ad2992c3a", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summaries?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summaries" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Access Summaries", - "id": "31339c3a-149a-44c7-a98c-8064ceb48db5", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-summaries/:type?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-summaries", - ":type" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407)\n\nFiltering is supported for the following fields and operators:\n\n**completed**: *eq, ne*\n\n**access.id**: *eq, in*\n\n**access.name**: *eq, sw*\n\n**entitlement.sourceName**: *eq, sw*\n\n**accessProfile.sourceName**: *eq, sw*" - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.name**" - } - ], - "variable": [ - { - "id": "196ad448-44d9-4b82-a720-86989cf9b8b7", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "id": "58b12a3a-3538-493c-8c54-87bb5ebf74bd", - "key": "type", - "value": "ACCESS_PROFILE", - "description": "(Required) The type of access review item to retrieve summaries for" - }, - { - "id": "912c8123-aaed-4be3-ad4f-04a681bc69e9", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns a list of access summaries for the specified identity campaign certification and type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API." - }, - "response": [ - { - "id": "687c7cba-f504-489d-87f5-c62af6cccbfb", - "name": "List of access summaries", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-summaries/:type?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-summaries", - ":type" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "type", - "value": "ACCESS_PROFILE", - "description": "(Required) The type of access review item to retrieve summaries for" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"access\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c9180857182305e01719937429e2bad\",\n \"name\": \"CN=Engineering\"\n },\n \"entitlement\": {\n \"id\": \"2c9180857182305e01719937429e2bad\",\n \"name\": \"CN=Engineering\",\n \"description\": \"Access to the engineering database\",\n \"privileged\": false,\n \"owner\": {\n \"email\": \"brandon.gray@acme-solar.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180867160846801719932c5153fb7\",\n \"name\": \"Brandon Gray\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=Engineering\",\n \"sourceName\": \"ODS-AD-Source\",\n \"hasPermissions\": true,\n \"revocable\": true\n }\n }\n]" - }, - { - "id": "37674d6a-df3b-4e7a-bd3b-ab94e78e97f8", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-summaries/:type?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-summaries", - ":type" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "type", - "value": "ACCESS_PROFILE", - "description": "(Required) The type of access review item to retrieve summaries for" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0a47eb49-211d-4f4f-b6b4-cc609690e6c2", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-summaries/:type?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-summaries", - ":type" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "type", - "value": "ACCESS_PROFILE", - "description": "(Required) The type of access review item to retrieve summaries for" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "4e53098f-c38a-45c3-abf3-a16f89e36df2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-summaries/:type?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-summaries", - ":type" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "type", - "value": "ACCESS_PROFILE", - "description": "(Required) The type of access review item to retrieve summaries for" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "c71de1e4-fc6f-4b04-b20a-7a109e6edcd2", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-summaries/:type?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-summaries", - ":type" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "type", - "value": "ACCESS_PROFILE", - "description": "(Required) The type of access review item to retrieve summaries for" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "9ca0d3bc-6895-4354-b054-9b68dbf693fb", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-summaries/:type?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-summaries", - ":type" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "type", - "value": "ACCESS_PROFILE", - "description": "(Required) The type of access review item to retrieve summaries for" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "901ed61e-fd54-4b3e-a138-1c50032bd7a4", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/access-summaries/:type?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "access-summaries", - ":type" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "type", - "value": "ACCESS_PROFILE", - "description": "(Required) The type of access review item to retrieve summaries for" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Summary for Identity", - "id": "d9637695-9fde-4afa-b33a-409fc2daf5d4", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summary/:identitySummaryId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summary", - ":identitySummaryId" - ], - "variable": [ - { - "id": "7abc516d-8a56-4196-ba13-a7fa6d22f0ff", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "id": "60172f54-b2ff-4ba0-943a-fec2648a9b6d", - "key": "identitySummaryId", - "value": "2c91808772a504f50172a9540e501ba8", - "description": "(Required) The identity summary ID" - }, - { - "id": "1f001748-462c-4dfb-bf38-f85a1183328c", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns the summary for an identity on a specified identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API." - }, - "response": [ - { - "id": "73212089-bf05-42c6-a7a5-eacfc3bd92e9", - "name": "An identity summary", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summary/:identitySummaryId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summary", - ":identitySummaryId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "identitySummaryId", - "value": "2c91808772a504f50172a9540e501ba8", - "description": "(Required) The identity summary ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808772a504f50172a9540e501ba7\",\n \"name\": \"Alison Ferguso\",\n \"identityId\": \"2c9180857182306001719937377a33de\",\n \"completed\": true\n}" - }, - { - "id": "bc98a766-ae09-4f68-8666-1e8f8d851f8a", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summary/:identitySummaryId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summary", - ":identitySummaryId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "identitySummaryId", - "value": "2c91808772a504f50172a9540e501ba8", - "description": "(Required) The identity summary ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "38e6f28b-0e92-4699-a0c6-21bbeb344c24", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summary/:identitySummaryId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summary", - ":identitySummaryId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "identitySummaryId", - "value": "2c91808772a504f50172a9540e501ba8", - "description": "(Required) The identity summary ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "8dc78f17-217c-4d61-8244-0c68c45195d8", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summary/:identitySummaryId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summary", - ":identitySummaryId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "identitySummaryId", - "value": "2c91808772a504f50172a9540e501ba8", - "description": "(Required) The identity summary ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "a3470688-7917-4aab-b918-7720fb7e6f8b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summary/:identitySummaryId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summary", - ":identitySummaryId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "identitySummaryId", - "value": "2c91808772a504f50172a9540e501ba8", - "description": "(Required) The identity summary ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "37ebfd5a-b457-4c9a-9e34-59e1df6f1465", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/certifications/:id/identity-summary/:identitySummaryId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "certifications", - ":id", - "identity-summary", - ":identitySummaryId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The identity campaign certification ID" - }, - { - "key": "identitySummaryId", - "value": "2c91808772a504f50172a9540e501ba8", - "description": "(Required) The identity summary ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "e9563cd1-7f36-4d8b-bc9f-f66edd08c30a" - }, - { - "name": "Lifecycle States", - "item": [ - { - "name": "Set Lifecycle State", - "id": "e5362af8-d443-4cd4-8ee7-5b2ef3fdf879", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"lifecycleStateId\": \"2c9180877a86e408017a8c19fefe046c\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identities/:identity-id/set-lifecycle-state", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identities", - ":identity-id", - "set-lifecycle-state" - ], - "variable": [ - { - "id": "28d0860e-b4ba-4852-80cb-2387b2b7dace", - "key": "identity-id", - "value": "2c9180857893f1290178944561990364", - "description": "(Required) The ID of the identity to update" - }, - { - "id": "bf945a23-cb10-4a7a-bc8c-89ac2a69f9fd", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile.\nA token with ORG_ADMIN or API authority is required to call this API." - }, - "response": [ - { - "id": "95f8f7a5-6cdb-4cee-9f5d-82f2aa5160cd", - "name": "The request was successfully accepted into the system.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"lifecycleStateId\": \"2c9180877a86e408017a8c19fefe046c\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identities/:identity-id/set-lifecycle-state", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identities", - ":identity-id", - "set-lifecycle-state" - ], - "variable": [ - { - "key": "identity-id", - "value": "2c9180857893f1290178944561990364", - "description": "(Required) The ID of the identity to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"accountActivityId\": \"2c9180837ab5b716017ab7c6c9ef1e20\"\n}" - }, - { - "id": "4f6dc88c-642f-4d21-9790-837fa9e524f9", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"lifecycleStateId\": \"2c9180877a86e408017a8c19fefe046c\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identities/:identity-id/set-lifecycle-state", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identities", - ":identity-id", - "set-lifecycle-state" - ], - "variable": [ - { - "key": "identity-id", - "value": "2c9180857893f1290178944561990364", - "description": "(Required) The ID of the identity to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "52c429d6-b729-4538-ac6e-17bae5ded747", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"lifecycleStateId\": \"2c9180877a86e408017a8c19fefe046c\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identities/:identity-id/set-lifecycle-state", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identities", - ":identity-id", - "set-lifecycle-state" - ], - "variable": [ - { - "key": "identity-id", - "value": "2c9180857893f1290178944561990364", - "description": "(Required) The ID of the identity to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "13294459-0e82-448f-a3bc-d79f495f7efa", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"lifecycleStateId\": \"2c9180877a86e408017a8c19fefe046c\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identities/:identity-id/set-lifecycle-state", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identities", - ":identity-id", - "set-lifecycle-state" - ], - "variable": [ - { - "key": "identity-id", - "value": "2c9180857893f1290178944561990364", - "description": "(Required) The ID of the identity to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "73fb2c08-ceaf-41c6-8d0e-20059d9a30d9", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"lifecycleStateId\": \"2c9180877a86e408017a8c19fefe046c\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identities/:identity-id/set-lifecycle-state", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identities", - ":identity-id", - "set-lifecycle-state" - ], - "variable": [ - { - "key": "identity-id", - "value": "2c9180857893f1290178944561990364", - "description": "(Required) The ID of the identity to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "53352aa6-6151-47eb-af78-672ab3520d47", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"lifecycleStateId\": \"2c9180877a86e408017a8c19fefe046c\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identities/:identity-id/set-lifecycle-state", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identities", - ":identity-id", - "set-lifecycle-state" - ], - "variable": [ - { - "key": "identity-id", - "value": "2c9180857893f1290178944561990364", - "description": "(Required) The ID of the identity to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Lists LifecycleStates", - "id": "7d1b43ad-7295-428b-ab3c-369fa097821d", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states?limit=250&offset=0&count=true&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**" - } - ], - "variable": [ - { - "id": "a0e9236e-c164-4a9b-91b2-b4f99fc6f4b4", - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) The IdentityProfile id" - }, - { - "id": "29316aa7-988a-4113-a9a7-174bbc04ff3b", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point lists all the LifecycleStates associated with IdentityProfiles.\nA token with API, or ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "50bdff0c-cb27-4cfa-b600-d7db9bdd01d8", - "name": "List of LifecycleState objects", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states?limit=250&offset=0&count=true&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) The IdentityProfile id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"id\": \"id12345\",\n \"created\": \"2016-04-03T10:04:44.626Z\",\n \"modified\": \"1991-04-26T06:18:54.660Z\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"identityCount\": 42,\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"id\": \"id12345\",\n \"created\": \"2013-12-13T01:49:01.555Z\",\n \"modified\": \"2021-04-21T11:59:35.343Z\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"identityCount\": 42,\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n]" - }, - { - "id": "fea8ff10-522c-405a-a556-14bc1c6e3a16", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states?limit=250&offset=0&count=true&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) The IdentityProfile id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "1e3ffda7-69e8-4597-8cc9-dc587058d1f2", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states?limit=250&offset=0&count=true&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) The IdentityProfile id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "bc088b74-2aec-4a4a-9462-d58008c29e48", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states?limit=250&offset=0&count=true&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) The IdentityProfile id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "993e3a46-ca7e-4432-b745-fead6ce78afb", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states?limit=250&offset=0&count=true&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) The IdentityProfile id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "9dcdc3b9-b77a-4abf-b315-6d9010caf321", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states?limit=250&offset=0&count=true&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) The IdentityProfile id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create Lifecycle State", - "id": "a296eb61-e920-42ef-8a61-f88784ab102d", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "variable": [ - { - "id": "4e0139b9-0656-4302-8a44-4268b1190a9d", - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "id": "4efe4e71-b434-42fd-9ab9-282f51e4d43c", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API creates a new Lifecycle State.\nA token with ORG_ADMIN or API authority is required to call this API." - }, - "response": [ - { - "id": "a866a397-ba87-45ef-b3be-e3f2a0795ac7", - "name": "Created LifecycleState object.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"id\": \"id12345\",\n \"created\": \"1957-09-16T23:36:34.741Z\",\n \"modified\": \"2001-05-12T01:13:58.887Z\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"identityCount\": 42,\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}" - }, - { - "id": "d2ec1f70-8e80-48d1-9ce5-9ca787e0be99", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "f9e954c8-2532-4fd1-a651-9ebe355c21c9", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "98e992a5-2fb4-4b42-96e4-e5a74c691c89", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "249da398-6603-4e87-aad7-b22e1df62737", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "f7503804-e46b-457c-ac74-d8412d01a7f2", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieves Lifecycle State", - "id": "16962287-bb31-4433-b833-dfcc62213b1b", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "id": "bc61551a-16be-4d16-b664-9b5109477078", - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "id": "23b89e47-1373-46fb-9ee0-7210787326dc", - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "id": "429df2c2-8ac1-42b2-abb5-20b4ec8101c7", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint retrieves a Lifecycle State.\nA token with ORG_ADMIN or API authority is required to call this API." - }, - "response": [ - { - "id": "0007b3c3-c066-47be-8e02-3004ea8acc62", - "name": "The requested LifecycleState was successfully retrieved.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"id\": \"id12345\",\n \"created\": \"1957-09-16T23:36:34.741Z\",\n \"modified\": \"2001-05-12T01:13:58.887Z\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"identityCount\": 42,\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}" - }, - { - "id": "58d3e6cf-4ad6-451f-8f74-a887cb355251", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "2c62da19-b5b1-49ee-bd1d-e8288003d747", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "1515165e-0e45-4698-83c9-896c051b91c1", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "c13a27c6-5a41-43ca-9b14-4c3478e92c75", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "1e48570c-6cad-4658-88fb-6056f1a69d27", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "13c3ed84-d1f9-45af-9ae6-74d6a8d6f14a", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Lifecycle State", - "id": "0234c16f-2190-430f-9770-08cf76e5ca88", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object],[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "id": "41586c1b-05f3-4656-a56d-4a5c4610d958", - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "id": "fff1fdc6-e55a-451d-8d0e-fde86b221d1f", - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "id": "9fe09394-fd01-4ee1-8736-db314e6789b3", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint updates individual Lifecycle State fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nA token with ORG_ADMIN or API authority is required to call this API." - }, - "response": [ - { - "id": "899705f5-4993-430b-9adc-2fa6a57d6a17", - "name": "The LifecycleState was successfully updated.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object],[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"aName\",\n \"technicalName\": \"Technical Name\",\n \"id\": \"id12345\",\n \"created\": \"1957-09-16T23:36:34.741Z\",\n \"modified\": \"2001-05-12T01:13:58.887Z\",\n \"enabled\": true,\n \"description\": \"Lifecycle description\",\n \"identityCount\": 42,\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}" - }, - { - "id": "e0b042ef-6b2e-4382-abb9-d2d04eb06af8", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object],[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "11371e97-6b93-43d3-a6d0-718b76f13140", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object],[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "f81a39e4-7d2b-4850-af16-b5c539aa8103", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object],[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "2a58dc52-3cb3-457a-96e1-d7c1f1b98ae3", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object],[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "d101197d-eee7-45df-ba8d-0c7f5b765503", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object],[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c7308579-edc5-415e-903a-eb2870f45e1f", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object],[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Lifecycle State by ID", - "id": "0858bf7b-17c5-4dc6-8c4f-81e41235d371", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "id": "3b69ff1e-197d-4bed-8754-ef9248e18eca", - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "id": "e279926c-ea5d-4292-9812-fe582f75c613", - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "id": "64b9469d-fcce-41a0-81df-640c5630d83a", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint deletes the Lifecycle State using it's ID.\nA token with API, or ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "58442b57-1eee-4883-bb69-2cba08f65432", - "name": "The request was successfully accepted into the system.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n}" - }, - { - "id": "2fa474e0-ae8f-4fd3-8f4f-11e3c6f367f5", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e9f55ee9-1ebd-403d-a043-a445420510eb", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "a53bdafa-8c42-4df8-975a-4682dec65cad", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "46773662-72ee-4a4d-9e89-c9e335e49760", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "12f9062b-4d5d-4d5d-bb3e-a0be3d2dcea5", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "086c0698-b221-4cff-aa2e-39067fbbd02e", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "lifecycle-states", - ":lifecycle-state-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "eu", - "description": "(Required) Identity Profile ID" - }, - { - "key": "lifecycle-state-id", - "value": "eu", - "description": "(Required) Lifecycle State ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "7167f133-7622-4e00-a3af-783d068e3bf0", - "description": "Use this API to implement and customize lifecycle state functionality.\nWith this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have.\n\nA lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with IdentityNow: 'Active' and 'Inactive.' \nWhen an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. \nThe inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. \nThis saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. \n\nAdministrators can create a variety of custom lifecycle states. See [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas.\n\nAdministrators must define the criteria for being in each lifecycle state, and they must define how IdentityNow manages users' access to apps and sources for each lifecycle state.\n\nIn IdentityNow, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. \n\nIn the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: \n\n- Enable/disable the lifecycle state for the identity profile.\n\n- Enable/disable source accounts for the identity profile's lifecycle state.\n\n- Add existing access profiles to grant to the identity profiles in that lifecycle state.\n\n- Create a new access profile to grant to the identity profile in that lifecycle state.\n\nAccess profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. \nTo maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. \nFor example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states.\n\nDuring scheduled refreshes, IdentityNow evaluates lifFecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. \nIf the identities are missing access, IdentityNow provisions that access. \n\nAdministrators can also use the 'Provisioning' tab to configure email notifications for IdentityNow to send whenever an identity with that identity profile has a lifecycle state change. \nSee [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so.\n\nAn identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' \nSee [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. \n\nRefer to the following link for more information about lifecycle states:\n" - }, - { - "name": "Identity Profiles", - "item": [ - { - "name": "Identity Profiles List", - "id": "03f77fad-b353-46ec-9154-2129a92ca40d", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*" - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**" - } - ], - "variable": [ - { - "id": "869f0840-5d9d-4639-97e8-09f02b05c0b3", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This returns a list of Identity Profiles based on the specified query parameters.\nA token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles." - }, - "response": [ - { - "id": "e445b69c-99d4-4b07-965d-98fb7e6705dc", - "name": "List of identityProfiles.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"ex63\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"ametca\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"f0e4cfba-277b-a47e-105d-67361591d0cf\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"cupidatat6\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"laboris95b\": {},\n \"dolor_610\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:5114ffba-cdb7-17c1-8828-72c69de8d02f\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n]" - }, - { - "id": "c376894b-993b-468e-b96d-94403543d286", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "5ffbd79f-984d-4da1-9358-d8493ceacd30", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "0cdb7371-f35d-430c-8935-30ae56c1dbea", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "ea4093f1-d513-42e5-a191-d677d4fb96e7", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "2ed8cb1f-7559-445d-93e0-99d7900e9124", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Export Identity Profiles", - "id": "ea5f1d79-6a3f-40e2-a459-e2a226e21554", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/export?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "export" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*" - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**" - } - ], - "variable": [ - { - "id": "cae37a79-7146-49f8-a06a-99f0de17ca06", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This exports existing identity profiles in the format specified by the sp-config service." - }, - "response": [ - { - "id": "f98965c3-9539-4ca2-ae88-cb1a85c57cee", - "name": "List of export objects with identity profiles.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/export?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "export" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"laboref8e\": {},\n \"nisi_02\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"veniam_c97\": {},\n \"reprehenderit_e\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:508c1137-a1e4-d89b-a072-981eac7aee83\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n },\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"ex_79\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"dolore00\": {},\n \"sitf\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"57381cf4-74a0-1b2e-c1c4-2827079e6c13\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\n]" - }, - { - "id": "f98b9e89-9f03-42a4-861d-ef507f1e88ca", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/export?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "export" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "d0240222-3015-493a-9e29-2acf798cd7b1", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/export?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "export" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ec7754db-ca11-4a2a-8f05-a5e5347b82c9", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/export?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "export" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "d7918dd1-fc72-4d3f-b779-a48d8f317ba6", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/export?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "export" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "560341d5-3c20-4f67-89e5-ab70f2b13818", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/export?limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "export" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Import Identity Profiles", - "id": "83fd6ecd-4ac1-479b-863f-60374cc4b64d", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"laboref8e\": {},\n \"nisi_02\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"veniam_c97\": {},\n \"reprehenderit_e\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:508c1137-a1e4-d89b-a072-981eac7aee83\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n },\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"ex_79\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"dolore00\": {},\n \"sitf\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"57381cf4-74a0-1b2e-c1c4-2827079e6c13\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/import", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "import" - ], - "variable": [ - { - "id": "b9bb5c64-4d43-4f4a-9aa5-6db637068739", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This imports previously exported identity profiles." - }, - "response": [ - { - "id": "e9337867-a493-466f-8cde-a148fd7aa0dc", - "name": "The result of importing Identity Profiles.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"elit_dc\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"enim17\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:d3f703f7-8b0d-cf14-df54-4f1f041a4822\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n },\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"consequat_4\": {},\n \"culpa7c\": {},\n \"magna_8\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"exc41\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"8a85f9f1-7edd-3fa8-7f60-6dd04d88a9ea\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/import", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "import" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"infos\": [\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"sunt0b\": {},\n \"exercitationaaa\": {}\n }\n },\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"aliqua8e\": {}\n }\n }\n ],\n \"warnings\": [\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"sed5\": {}\n }\n },\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"dolor01e\": {},\n \"Ut_73\": {}\n }\n }\n ],\n \"errors\": [\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"aliquip_19\": {},\n \"ea293\": {},\n \"ad_b2\": {}\n }\n },\n {\n \"key\": \"UNKNOWN_REFERENCE_RESOLVER\",\n \"text\": \"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]\",\n \"details\": {\n \"eu__1\": {}\n }\n }\n ],\n \"importedObjects\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n }\n ]\n}" - }, - { - "id": "9237bb5a-eda9-4508-8fde-3193b7ec719e", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"elit_dc\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"enim17\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:d3f703f7-8b0d-cf14-df54-4f1f041a4822\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n },\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"consequat_4\": {},\n \"culpa7c\": {},\n \"magna_8\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"exc41\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"8a85f9f1-7edd-3fa8-7f60-6dd04d88a9ea\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/import", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "import" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "01ebb5ff-6ee6-4e86-97fe-d4a0416fce33", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"elit_dc\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"enim17\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:d3f703f7-8b0d-cf14-df54-4f1f041a4822\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n },\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"consequat_4\": {},\n \"culpa7c\": {},\n \"magna_8\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"exc41\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"8a85f9f1-7edd-3fa8-7f60-6dd04d88a9ea\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/import", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "import" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "c0596da2-0a19-4f1b-ab8f-53a1ffc80e15", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"elit_dc\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"enim17\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:d3f703f7-8b0d-cf14-df54-4f1f041a4822\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n },\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"consequat_4\": {},\n \"culpa7c\": {},\n \"magna_8\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"exc41\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"8a85f9f1-7edd-3fa8-7f60-6dd04d88a9ea\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/import", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "import" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "ccc17d65-669a-4427-b02c-cf92433f4499", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"elit_dc\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"enim17\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:d3f703f7-8b0d-cf14-df54-4f1f041a4822\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n },\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"consequat_4\": {},\n \"culpa7c\": {},\n \"magna_8\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"exc41\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"8a85f9f1-7edd-3fa8-7f60-6dd04d88a9ea\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/import", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "import" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "63444496-3edd-4add-bb1d-8b1846261ed6", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"elit_dc\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"enim17\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"urn:uuid:d3f703f7-8b0d-cf14-df54-4f1f041a4822\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n },\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"object\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"consequat_4\": {},\n \"culpa7c\": {},\n \"magna_8\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"exc41\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"8a85f9f1-7edd-3fa8-7f60-6dd04d88a9ea\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n }\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identity-profiles/import", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - "import" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get single Identity Profile", - "id": "846dd08a-cc29-41d1-9447-820dcecdcd2f", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id" - ], - "variable": [ - { - "id": "19cec657-7dda-4116-86b6-6b59f741e2a5", - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "id": "064e09d6-a6d3-4811-8d23-a03547425d3e", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This returns a single Identity Profile based on ID.\nA token with ORG_ADMIN or API authority is required to call this API." - }, - "response": [ - { - "id": "d4ec4511-509d-4696-854b-78ed4f080809", - "name": "An Identity Profile object.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"ut_c\": {},\n \"consectetur_8\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"laborum_14\": {}\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"12b7960c-3715-8055-c13f-dd9a88dfece6\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n}" - }, - { - "id": "94a664e6-5ccd-44f5-88a6-8b06d961701d", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "e88b298b-43d5-44ab-abef-33667fe4513b", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "3feb75a1-7cc8-4c8a-9cc6-1991c10ae335", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "c924f8fe-b844-4e5c-afc2-d610c6fc4b9b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c57eda03-c934-4d96-b4f0-551823772a07", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get default Identity Attribute Config", - "id": "62b87fcd-e9b1-4ec1-9fb6-176cf47f09a5", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/default-identity-attribute-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "default-identity-attribute-config" - ], - "variable": [ - { - "id": "d0f18b41-dd29-45fd-98f4-6ddec413ab84", - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "id": "c6b38255-76f8-41ee-b65d-1d5c351c8a4e", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This returns the default identity attribute config.\nA token with ORG_ADMIN authority is required to call this API to get the default identity attribute config." - }, - "response": [ - { - "id": "dac0da35-656a-4bff-a964-f6c331d77584", - "name": "An Identity Attribute Config object.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/default-identity-attribute-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "default-identity-attribute-config" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"laborum__8_\": {},\n \"laboris4\": {},\n \"nisid\": {}\n }\n }\n },\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"consequat_163\": {}\n }\n }\n }\n ]\n}" - }, - { - "id": "66356242-3395-4d46-a79c-f6f483f9cdb0", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/default-identity-attribute-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "default-identity-attribute-config" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "97b65b7f-848f-4243-8939-39da486e321d", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/default-identity-attribute-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "default-identity-attribute-config" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "e1416c9c-e720-4dd4-b683-eb58842d52c4", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/default-identity-attribute-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "default-identity-attribute-config" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "247920de-f7ba-4503-9ee4-de6f5b3af218", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/default-identity-attribute-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "default-identity-attribute-config" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "aef10100-d59b-4062-b733-3482267167cf", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/identity-profiles/:identity-profile-id/default-identity-attribute-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity-profiles", - ":identity-profile-id", - "default-identity-attribute-config" - ], - "variable": [ - { - "key": "identity-profile-id", - "value": "29d0ff2a-3af2-efb2-d09c-7916a3af8027", - "description": "(Required) The Identity Profile ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "54c60a0e-177d-47c2-bd7e-2a83b5f175b6", - "description": "Use this API to implement identity profile functionality. \nWith this functionality in place, administrators can view identity profiles and their configurations. \n\nIdentity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. \n\nIn IdentityNow, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. \nThis list shows some details about each identity profile, along with its status. \nThey can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. \n\nRefer to the following link for more information about identity profiles:\n" - }, - { - "name": "Non-Employee Lifecycle Management", - "item": [ - { - "name": "Create Non-Employee Record", - "id": "359bde02-86e9-4c98-87a1-80917be1ed43", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "variable": [ - { - "id": "f01bf731-7651-4463-bab4-875fa3ca5224", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will create a non-employee record.

\nRequires role context of `idn:nesr:create` " - }, - "response": [ - { - "id": "31a37ca0-4edc-4b82-a96d-671fcf7f1bb6", - "name": "Created non-employee record.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"qui esse\",\n \"accountName\": \"qui\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"data\": {\n \"nisi_9e3\": \"enim magna sunt\",\n \"et_b\": \"non velit qui cillum\",\n \"ut8\": \"amet dolor nulla minim\",\n \"laboris_6d\": \"ut\"\n },\n \"startDate\": \"2019-08-23T18:52:59.162Z\",\n \"endDate\": \"2020-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n}" - }, - { - "id": "be57d095-ddd5-4b28-96eb-690bfc9581eb", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "a14a20cb-3f60-40b8-9a32-6b95a93b3d0d", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "7c495134-9076-4415-acaf-046481e7cd3b", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "3a7995f6-899a-4690-bbea-c63081f11e39", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "709d5bf5-ab9b-436d-aaa9-3c6e6846e911", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "List Non-Employee Records", - "id": "c6be2a34-5058-4976-a3e7-1c8df150c4fe", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records?limit=250&offset=0&count=true&sorters=accountName,sourceId&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "sorters", - "value": "accountName,sourceId", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)

Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)

Filtering is supported for the following fields and operators:

**sourceId**: *eq*

*Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "id": "fa5d8209-8128-4ed2-8268-6c388b75afe5", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a list of non-employee records.

There are two contextual uses for this endpoint:
\n 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees.
\n 2. The user is an account manager, in which case they can get a list of the non-employees that they manage." - }, - "response": [ - { - "id": "7045f0bb-ee1e-4aae-ad2d-bf6bf193608d", - "name": "Non-Employee record objects", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records?limit=250&offset=0&count=true&sorters=accountName,sourceId&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "accountName,sourceId" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"anim\",\n \"accountName\": \"Duis adipisicing\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"data\": {\n \"dolore19\": \"exercitation qui in dolor\",\n \"ad_3\": \"quis\",\n \"irure1ef\": \"Ut irure officia consectetur\"\n },\n \"startDate\": \"2019-08-23T18:52:59.162Z\",\n \"endDate\": \"2020-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n },\n {\n \"id\": \"commodo\",\n \"accountName\": \"qui pariatur in\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"data\": {\n \"cupidatat67d\": \"aliqua occaecat\",\n \"sunt2_c\": \"dolor eiusmod\"\n },\n \"startDate\": \"2019-08-23T18:52:59.162Z\",\n \"endDate\": \"2020-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n }\n]" - }, - { - "id": "a9f4255d-689d-46b6-860e-7ce68b26ec56", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records?limit=250&offset=0&count=true&sorters=accountName,sourceId&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "accountName,sourceId" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "c1cdcef6-19dc-47cd-9051-2606ee9ecb94", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records?limit=250&offset=0&count=true&sorters=accountName,sourceId&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "accountName,sourceId" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "397f56df-2647-4fa6-9e08-91fc1b1a7ad3", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records?limit=250&offset=0&count=true&sorters=accountName,sourceId&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "accountName,sourceId" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1d73c77f-bde7-47b4-8294-1008ee068b1a", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records?limit=250&offset=0&count=true&sorters=accountName,sourceId&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "accountName,sourceId" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "cc06e977-aca9-41ef-9d9b-c183d80b6075", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records?limit=250&offset=0&count=true&sorters=accountName,sourceId&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "sorters", - "value": "accountName,sourceId" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get a Non-Employee Record", - "id": "d197daa2-fb05-4372-90f0-c1ee1ea8e12b", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "id": "1a4d2de7-46c6-4bb5-a3db-b182a7991784", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "id": "fbdb4f61-7d0a-46da-b46c-6d8f11c3fdc6", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a non-employee record.

\nRequires role context of `idn:nesr:read`" - }, - "response": [ - { - "id": "1bba115c-4606-4a88-9737-3abfe21915e8", - "name": "Non-Employee record object", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"qui esse\",\n \"accountName\": \"qui\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"data\": {\n \"nisi_9e3\": \"enim magna sunt\",\n \"et_b\": \"non velit qui cillum\",\n \"ut8\": \"amet dolor nulla minim\",\n \"laboris_6d\": \"ut\"\n },\n \"startDate\": \"2019-08-23T18:52:59.162Z\",\n \"endDate\": \"2020-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n}" - }, - { - "id": "ab0d5a3b-b062-4751-a024-c89737d0d50e", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "a62de2c0-1dfe-4914-b318-3f3059c64e8b", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "5f28929d-2ca8-4ea7-95af-c90679dbc7d8", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "345f7ba0-c798-4a33-9c8c-d090d32397a5", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "ae83cb7a-adb0-417a-a59c-e85628a9d850", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Non-Employee Record", - "id": "7e4ceb7f-a88c-4116-8641-1a7b5c3864e6", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "id": "f7f61c09-7c02-47e5-80fe-f4d190798635", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "id": "5e8db781-7d9b-48b8-b3e9-bb3b41411252", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will update a non-employee record.

There are two contextual uses for this endpoint:
\n 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields.
\n 2. The user is owner of the source, in this case they can only update the end date. " - }, - "response": [ - { - "id": "1f3bf4f9-30d9-4b81-b306-06b192dd1cff", - "name": "An updated non-employee record.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"qui esse\",\n \"accountName\": \"qui\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"data\": {\n \"nisi_9e3\": \"enim magna sunt\",\n \"et_b\": \"non velit qui cillum\",\n \"ut8\": \"amet dolor nulla minim\",\n \"laboris_6d\": \"ut\"\n },\n \"startDate\": \"2019-08-23T18:52:59.162Z\",\n \"endDate\": \"2020-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n}" - }, - { - "id": "e53d15c9-cf06-4c9a-b3b6-17c28fb2bc65", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b9977570-86ad-4e0f-a24b-9890f81d0f8f", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "386b03db-aa61-4b17-b076-576aa95eee87", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "2b14d856-e43f-46df-84b4-1c92db4dfb38", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "e38e8c0d-f002-48a4-b7a9-cf20476949fb", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "140645f6-ae00-4822-aa8a-6b822e0bad6b", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Patch Non-Employee Record", - "id": "84306a7b-d666-4574-8c87-0f36a32ea9a6", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "id": "5b9fd13b-2ee9-4665-b4fe-ce7e6d41d03b", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "id": "5fb0d9d2-8086-431d-8601-5ffbaac37f89", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will patch a non-employee record.

There are two contextual uses for this endpoint:
\n 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields.
\n 2. The user is owner of the source, in this case they can only update the end date. " - }, - "response": [ - { - "id": "e4f155db-5da9-4a1b-b949-393072a3a703", - "name": "A patched non-employee record.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"qui esse\",\n \"accountName\": \"qui\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"data\": {\n \"nisi_9e3\": \"enim magna sunt\",\n \"et_b\": \"non velit qui cillum\",\n \"ut8\": \"amet dolor nulla minim\",\n \"laboris_6d\": \"ut\"\n },\n \"startDate\": \"2019-08-23T18:52:59.162Z\",\n \"endDate\": \"2020-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n}" - }, - { - "id": "b479d25b-6425-404e-ac76-467c8c954fd9", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "c0fcb841-6072-4338-bc36-e682034aab2a", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "085af118-9781-4504-b143-a8ac5d8dbd8e", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "a7b3ce96-f81c-4122-903c-2f3ad73c3f39", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "536872ff-61f8-479f-8a34-df531bbc0179", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "5c6c8de5-0ead-422f-82b3-1194d55d88f4", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Non-Employee Record", - "id": "b21e6828-7e07-4c7c-b3dc-a996075191c1", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "id": "2d01f9b5-5392-4ede-b051-add3daf53946", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "id": "d19b9eb1-8258-4a3f-8d53-01ad732a3c15", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will delete a non-employee record.

\nRequires role context of `idn:nesr:delete`" - }, - "response": [ - { - "id": "5118c5d9-2d70-42f2-95a1-74ef5c170e3b", - "name": "No content - indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "c24e70ae-e1b7-4c2b-a820-d6268747db91", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "472b6b49-8951-41f6-be6c-3f6cc6a0180b", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "3d0f1ca5-81b4-4af4-947c-732897407a77", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1a05f854-a4bd-4cd6-9b9c-07782c20cd26", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "b359a49f-becf-40f9-b5d6-c92431e1121c", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-records/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee record id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Multiple Non-Employee Records", - "id": "5caff4db-c921-412c-a57b-52ed9f6339ca", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"9155843b-5a04-7082-40ce-3cb283c7c370\",\n \"8aabbd0b-89cc-16bc-3086-83ae92c19fac\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/bulk-delete", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - "bulk-delete" - ], - "variable": [ - { - "id": "e87715a2-601b-4fff-b0b3-0892699f864e", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will delete multiple non-employee records based on the non-employee ids provided.

Requires role context of `idn:nesr:delete`" - }, - "response": [ - { - "id": "a42c262e-72d6-43fb-a40a-ec15833ab84e", - "name": "No content - indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"7be4b75c-6e9c-1c77-e485-4577094b34ba\",\n \"urn:uuid:e8a58c8c-617f-cd37-58d8-1c942959b604\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/bulk-delete", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - "bulk-delete" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "8974da42-c2f7-4de9-a2c7-3f661acd80a1", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"7be4b75c-6e9c-1c77-e485-4577094b34ba\",\n \"urn:uuid:e8a58c8c-617f-cd37-58d8-1c942959b604\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/bulk-delete", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - "bulk-delete" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "df6de779-becb-41e0-9e59-ebe1773585d7", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"7be4b75c-6e9c-1c77-e485-4577094b34ba\",\n \"urn:uuid:e8a58c8c-617f-cd37-58d8-1c942959b604\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/bulk-delete", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - "bulk-delete" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "f761e2d4-3721-477d-8fb4-e4b15e85fa02", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"7be4b75c-6e9c-1c77-e485-4577094b34ba\",\n \"urn:uuid:e8a58c8c-617f-cd37-58d8-1c942959b604\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/bulk-delete", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - "bulk-delete" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "429e6b56-6f96-4292-b04d-47e237f8d948", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"7be4b75c-6e9c-1c77-e485-4577094b34ba\",\n \"urn:uuid:e8a58c8c-617f-cd37-58d8-1c942959b604\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/bulk-delete", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - "bulk-delete" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "fb2e659f-5e15-42f4-b083-a41457d3f3ba", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"7be4b75c-6e9c-1c77-e485-4577094b34ba\",\n \"urn:uuid:e8a58c8c-617f-cd37-58d8-1c942959b604\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-records/bulk-delete", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-records", - "bulk-delete" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create Non-Employee Request", - "id": "888c2350-cee9-44a9-b5b9-9d2cbf28cd63", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "variable": [ - { - "id": "1bd43d74-0382-40f8-b478-ddd03c384d0a", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will create a non-employee request and notify the approver.

Requires role context of `idn:nesr:create` or the user must own the source." - }, - "response": [ - { - "id": "0096311a-2cbd-4827-a565-330bb9637d14", - "name": "Non-Employee request creation object", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"nonEmployeeSource\": {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\"\n },\n \"data\": {\n \"ut__f_\": \"mollit dolore in nisi eiusmod\"\n },\n \"approvalItems\": [\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": 1,\n \"comment\": \"Duis dolor occaecat\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n },\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": 1,\n \"comment\": \"labore\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n }\n ],\n \"approvalStatus\": \"REJECTED\",\n \"comment\": \"veniam\",\n \"completionDate\": \"2020-03-24T11:11:41.139-05:00\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"modified\": \"2020-03-24T11:11:41.139-05:00\",\n \"created\": \"2020-03-24T11:11:41.139-05:00\"\n}" - }, - { - "id": "64c5664e-6f56-417c-8fcf-742149e17dd5", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"firstName is required; accountName is required;\"\n }\n ]\n}" - }, - { - "id": "1b72bc0d-c379-4c00-9523-6ba4d3be2e22", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "770ef6eb-4cf2-4ccd-a514-69aa93f56b05", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "6b13d183-1cb3-4da2-9caf-cd5cde494b52", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "bacfb408-7e6f-438a-bd94-534bcc508a0d", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"data\": {\n \"incididunt66\": \"pariatur\",\n \"Ut_1\": \"qui sint\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-requests", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "List Non-Employee Requests", - "id": "61e07060-d035-4081-ab85-3ac1668d3020", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests?limit=250&offset=0&count=true&requested-for=me&sorters=created,approvalStatus&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "requested-for", - "value": "me", - "description": "(Required) The identity for whom the request was made. *me* indicates the current user." - }, - { - "key": "sorters", - "value": "created,approvalStatus", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)

Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)

Filtering is supported for the following fields and operators:

**sourceId**: *eq*

*Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "id": "cbae0293-ce3b-4538-960e-056949b7d2f1", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a list of non-employee requests.

There are two contextual uses for the `requested-for` path parameter:
\n 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.
\n 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages." - }, - "response": [ - { - "id": "fac6e2f1-e56c-43c0-863d-9b2e1e0d2e71", - "name": "List of non-employee request objects.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests?limit=250&offset=0&count=true&requested-for=me&sorters=created,approvalStatus&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "sorters", - "value": "created,approvalStatus" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"nonEmployeeSource\": {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\"\n },\n \"data\": {\n \"irure_58\": \"deserunt laborum\",\n \"dolor_b\": \"fugiat minim sint ea\"\n },\n \"approvalItems\": [\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": 1,\n \"comment\": \"Duis\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n },\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": 1,\n \"comment\": \"et nostrud ex tempor\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n }\n ],\n \"approvalStatus\": \"REJECTED\",\n \"comment\": \"cupidatat in irure\",\n \"completionDate\": \"2020-03-24T11:11:41.139-05:00\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"modified\": \"2020-03-24T11:11:41.139-05:00\",\n \"created\": \"2020-03-24T11:11:41.139-05:00\"\n },\n {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"nonEmployeeSource\": {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\"\n },\n \"data\": {\n \"in__0c\": \"id aliquip nisi\",\n \"elit_8d9\": \"sunt non\",\n \"elit_065\": \"nostrud in Excepteur\",\n \"eaf05\": \"laboris occaecat\"\n },\n \"approvalItems\": [\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": 1,\n \"comment\": \"amet eiusmod\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n },\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": 1,\n \"comment\": \"in non sunt ut\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n }\n ],\n \"approvalStatus\": \"APPROVED\",\n \"comment\": \"officia in Duis cillum\",\n \"completionDate\": \"2020-03-24T11:11:41.139-05:00\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"modified\": \"2020-03-24T11:11:41.139-05:00\",\n \"created\": \"2020-03-24T11:11:41.139-05:00\"\n }\n]" - }, - { - "id": "a131d7b7-5bea-479b-bad7-c67177fca766", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests?limit=250&offset=0&count=true&requested-for=me&sorters=created,approvalStatus&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "sorters", - "value": "created,approvalStatus" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "9c320eac-fb68-4bc9-9607-80934e99563a", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests?limit=250&offset=0&count=true&requested-for=me&sorters=created,approvalStatus&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "sorters", - "value": "created,approvalStatus" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "78a7c869-b674-47d9-80a7-7ff30e3610c8", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests?limit=250&offset=0&count=true&requested-for=me&sorters=created,approvalStatus&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "sorters", - "value": "created,approvalStatus" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "50ea3a6c-2239-4605-95ee-eb56f6fa02d5", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests?limit=250&offset=0&count=true&requested-for=me&sorters=created,approvalStatus&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "sorters", - "value": "created,approvalStatus" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "bc190833-2912-45c5-9b3a-6ba7332cacc4", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests?limit=250&offset=0&count=true&requested-for=me&sorters=created,approvalStatus&filters=sourceId eq \"2c91808568c529c60168cca6f90c1313\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "sorters", - "value": "created,approvalStatus" - }, - { - "key": "filters", - "value": "sourceId eq \"2c91808568c529c60168cca6f90c1313\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get a Non-Employee Request", - "id": "339a04aa-c01e-4d79-afb0-16440d617897", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "id": "52b30d1f-6215-4b98-bc0f-6c5af5125a98", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee request id (UUID)" - }, - { - "id": "8d51c308-1c29-4091-aeae-5e901454ec96", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a non-employee request.

\nThere are two contextual uses for this endpoint:
\n 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user.
\n 2. The user must be the owner of the non-employee request." - }, - "response": [ - { - "id": "6c2516ee-3fb1-4e8e-98ee-2c191b3057f0", - "name": "Non-Employee request object.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee request id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"nonEmployeeSource\": {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\"\n },\n \"data\": {\n \"ut__f_\": \"mollit dolore in nisi eiusmod\"\n },\n \"approvalItems\": [\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": 1,\n \"comment\": \"Duis dolor occaecat\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n },\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": 1,\n \"comment\": \"labore\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n }\n ],\n \"approvalStatus\": \"REJECTED\",\n \"comment\": \"veniam\",\n \"completionDate\": \"2020-03-24T11:11:41.139-05:00\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"modified\": \"2020-03-24T11:11:41.139-05:00\",\n \"created\": \"2020-03-24T11:11:41.139-05:00\"\n}" - }, - { - "id": "517a5cab-5c8c-4c5a-9879-81f72406ec98", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee request id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0634e1cc-b92b-4339-a881-6e8ad31689b5", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee request id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "97ed0c8b-427f-4691-9be2-37fb322336cc", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee request id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1d28096e-c1d9-48bd-8bad-64656e0e6930", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee request id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "f8c378ac-c9c5-4d5c-98c5-49cf6739fc47", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee request id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c24f8a7f-b2fe-4be6-8edf-6192007c69f1", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) Non-Employee request id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Non-Employee Request", - "id": "91ec4b93-6a1a-4897-a892-5eec7478eae6", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "id": "b0578b18-5bab-4656-aee3-8812a491c0c7", - "key": "id", - "value": "28fac9b6-ff79-b5dc-7e42-921886786706", - "description": "(Required) Non-Employee request id in the UUID format" - }, - { - "id": "29d97fd7-5bb0-4920-91d0-ca47053304e9", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will delete a non-employee request.

\nRequires role context of `idn:nesr:delete`" - }, - "response": [ - { - "id": "21be04f0-0541-4fd9-bc59-38949c8899f0", - "name": "No content - indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "28fac9b6-ff79-b5dc-7e42-921886786706", - "description": "(Required) Non-Employee request id in the UUID format" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "f2d80064-8bce-403e-80ec-f7dba89cecee", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "28fac9b6-ff79-b5dc-7e42-921886786706", - "description": "(Required) Non-Employee request id in the UUID format" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "898c5518-12c3-4a00-ab8e-cd48b324aea0", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "28fac9b6-ff79-b5dc-7e42-921886786706", - "description": "(Required) Non-Employee request id in the UUID format" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "f13d0a83-211d-46a9-97ce-b58f2a16977b", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "28fac9b6-ff79-b5dc-7e42-921886786706", - "description": "(Required) Non-Employee request id in the UUID format" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b6d785b0-68c9-4fb1-8bb6-97cb4b877df7", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "28fac9b6-ff79-b5dc-7e42-921886786706", - "description": "(Required) Non-Employee request id in the UUID format" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "4e4cfa1a-1628-4d68-932f-00016e11b448", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "28fac9b6-ff79-b5dc-7e42-921886786706", - "description": "(Required) Non-Employee request id in the UUID format" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "61d7d889-c8d5-4410-9e81-1f19e1d48a5d", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "28fac9b6-ff79-b5dc-7e42-921886786706", - "description": "(Required) Non-Employee request id in the UUID format" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Summary of Non-Employee Requests", - "id": "6148549c-91de-4c0d-a822-b717657f3acd", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - "summary", - ":requested-for" - ], - "variable": [ - { - "id": "2a28feb4-c330-4f24-9726-65636fbf56de", - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "id": "48694f70-fac1-4572-af84-3f3a7ab5abee", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will retrieve a summary of non-employee requests.

There are two contextual uses for the `requested-for` path parameter:
\n 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id.
\n 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages." - }, - "response": [ - { - "id": "d4de987e-fb04-4a3d-80c4-61e7203f6bce", - "name": "Non-Employee request summary object.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"approved\": 71568185.4057937,\n \"rejected\": 26817267.494696483,\n \"pending\": -96184342.26303472,\n \"nonEmployeeCount\": 44825103.004063696\n}" - }, - { - "id": "21ab0483-c931-454a-8808-ae1d473809f6", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "7fc4319a-216d-4aea-bd03-f8ed90f06a36", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "93908b9a-b553-466f-9439-7fd287d28fee", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "c98a1651-4259-497b-9211-b96fd9a3e43f", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "2d04a780-2b35-4fd6-96a4-75e8d40832ea", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-requests/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-requests", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create Non-Employee Source", - "id": "0598bfbf-5a67-4c58-80e3-3e24510a3c90", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"owner\": {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"managementWorkgroup\": \"123299\",\n \"approvers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "variable": [ - { - "id": "435272e4-f9aa-40d5-92c8-0c8b2d438207", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will create a non-employee source.

Requires role context of `idn:nesr:create`" - }, - "response": [ - { - "id": "2aa105b1-8d81-4b4d-bb08-ff240cd321dd", - "name": "Created non-employee source.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"owner\": {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"managementWorkgroup\": \"123299\",\n \"approvers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"cloudExternalId\": \"99999\"\n}" - }, - { - "id": "d9d9eb5d-bbd2-44eb-b331-9de0c20cf7d4", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"owner\": {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"managementWorkgroup\": \"123299\",\n \"approvers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e43d5ce4-dd5a-4434-b362-63c533543e02", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"owner\": {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"managementWorkgroup\": \"123299\",\n \"approvers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "e5eb18a5-301b-40b3-b357-dd0d347921e2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"owner\": {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"managementWorkgroup\": \"123299\",\n \"approvers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "a1be8dbc-0f04-4ac6-8d3e-c47fefb77a2d", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"owner\": {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"managementWorkgroup\": \"123299\",\n \"approvers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c6630879-348d-4161-b068-19aac09961fb", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"owner\": {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"managementWorkgroup\": \"123299\",\n \"approvers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n },\n {\n \"id\": \"2c91808570313110017040b06f344ec9\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "List Non-Employee Sources", - "id": "07d98e9e-0ea3-4750-8f06-7925976c1907", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources?limit=250&offset=0&count=true&requested-for=me&non-employee-count=true&sorters=name,created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "requested-for", - "value": "me", - "description": "(Required) The identity for whom the request was made. *me* indicates the current user." - }, - { - "key": "non-employee-count", - "value": "true", - "description": "The flag to determine whether return a non-employee count associate with source." - }, - { - "key": "sorters", - "value": "name,created", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)

Sorting is supported for the following fields: **name, created**" - } - ], - "variable": [ - { - "id": "d5bd968f-d477-429a-b9db-ed307d1dbc0f", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a list of non-employee sources.

There are two contextual uses for the requested-for path parameter:
\n 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list sources assigned to a particular account manager by passing in that manager's id.
\n 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns." - }, - "response": [ - { - "id": "f14672fd-26b8-477e-9caf-aefa56afeeeb", - "name": "List of non-employee sources objects.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources?limit=250&offset=0&count=true&requested-for=me&non-employee-count=true&sorters=name,created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "non-employee-count", - "value": "true" - }, - { - "key": "sorters", - "value": "name,created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeCount\": -46458724.760349534\n },\n {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeCount\": 23721688.70320545\n }\n]" - }, - { - "id": "82774f03-ba78-4e44-b446-50d3cb66eb3b", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources?limit=250&offset=0&count=true&requested-for=me&non-employee-count=true&sorters=name,created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "non-employee-count", - "value": "true" - }, - { - "key": "sorters", - "value": "name,created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "2b2d7802-2eac-4644-9984-910d27815602", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources?limit=250&offset=0&count=true&requested-for=me&non-employee-count=true&sorters=name,created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "non-employee-count", - "value": "true" - }, - { - "key": "sorters", - "value": "name,created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "e14bcda7-6741-43e0-b6fa-7adbc39ec05e", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources?limit=250&offset=0&count=true&requested-for=me&non-employee-count=true&sorters=name,created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "non-employee-count", - "value": "true" - }, - { - "key": "sorters", - "value": "name,created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "d7f07076-b4af-4142-ae4c-0c33e52993ff", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources?limit=250&offset=0&count=true&requested-for=me&non-employee-count=true&sorters=name,created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "non-employee-count", - "value": "true" - }, - { - "key": "sorters", - "value": "name,created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "5d7407ae-26ef-498c-8680-f3a50b4748ae", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources?limit=250&offset=0&count=true&requested-for=me&non-employee-count=true&sorters=name,created", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "requested-for", - "value": "me" - }, - { - "key": "non-employee-count", - "value": "true" - }, - { - "key": "sorters", - "value": "name,created" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get a Non-Employee Source", - "id": "44932c28-4f72-46cd-94ae-e2e14456046f", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "id": "e387cbaf-2292-4c3a-8ad7-0a16229a13a5", - "key": "sourceId", - "value": "2c91808b7c28b350017c2a2ec5790aa1", - "description": "(Required) Source Id" - }, - { - "id": "fa5c5b2f-4d25-494b-8f81-2b216d70fc82", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a non-employee source.

There are two contextual uses for the requested-for path parameter:
\n 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source.
\n 2. The current user is an account manager, in which case the user can only request sources that they own." - }, - "response": [ - { - "id": "12fcb192-b7b6-46d0-993d-a9ede2440d3a", - "name": "Non-Employee source object.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c91808b7c28b350017c2a2ec5790aa1", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n}" - }, - { - "id": "66bfe94e-f3a8-46d7-80e8-bcf9a08ca999", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c91808b7c28b350017c2a2ec5790aa1", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "3970b62d-f386-43dc-a262-0ec307aba752", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c91808b7c28b350017c2a2ec5790aa1", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "4ef4aa65-c075-4d10-8c14-43f534cad5bf", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c91808b7c28b350017c2a2ec5790aa1", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "979ddbc1-475a-4445-85a1-016c3017c5ed", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c91808b7c28b350017c2a2ec5790aa1", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "e008cde0-da3b-48ef-8688-0a440ca7c915", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c91808b7c28b350017c2a2ec5790aa1", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Patch a Non-Employee Source", - "id": "532d56a1-c807-41d4-aa8a-5f7cefd02695", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "id": "db5ba718-d8fe-4ad7-943d-c84e6e027389", - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "id": "f4d978a4-9bc4-48e6-a1f3-a85d9aaf6cd4", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers**

Requires role context of `idn:nesr:update`." - }, - "response": [ - { - "id": "26283795-ba20-444e-b35b-6457bb78322a", - "name": "A patched non-employee source object.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n}" - }, - { - "id": "ae61f31f-e572-4674-9076-4fae6a5e47ef", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "037f1b50-3b41-48ee-bb84-c7b8c1de8ceb", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "92ae122c-11e4-4d0e-964e-8d571b46dae2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "77b68902-add9-4ec5-af9a-c0e9b38f4df2", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "e96df65e-d081-4b0d-b4c6-4166ad297368", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Non-Employee Source", - "id": "9436d208-33be-4347-adce-3798e4f177a5", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "id": "0fa9a621-8e47-40c5-ba3b-29aff2b1d17e", - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "id": "fbb6756f-8e8d-4a4f-9efb-18f67b62e5b8", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will delete a non-employee source.

Requires role context of `idn:nesr:delete`." - }, - "response": [ - { - "id": "88fdbba2-82eb-4ae1-ada8-54c2a9238805", - "name": "No content - indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "6a885b5b-ade2-4483-9d4a-477a1a1e1ead", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "8d2b43aa-1af4-4a28-ba4a-ad5e1cff7a43", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "865427a4-e528-4c63-936a-e809411d49d0", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "cb4f92b9-72b6-4752-874f-9d7f91739a1b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "cfcfedcb-d7e0-4d1c-8972-01cb47d18d8f", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) Source Id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Exports Non-Employee Records to CSV", - "id": "a8d4925f-2ab2-4fbe-8026-535ccfaee5f2", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "text/csv" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employees/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employees", - "download" - ], - "variable": [ - { - "id": "721d7de1-4228-4aeb-9a60-04894106e0c2", - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "id": "12ac34d6-71d6-4447-a63b-0431c2c8ba73", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This requests a CSV download for all non-employees from a provided source.

Requires role context of `idn:nesr:read`" - }, - "response": [ - { - "id": "3eb1e71f-2b35-4263-b63f-49111b14d769", - "name": "Exported CSV", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employees/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employees", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/csv" - } - ], - "cookie": [], - "responseTime": null, - "body": "accountName,firstName,lastName,phone,email,manager,startDate,endDate\nJon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00\nWilliam.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00\n" - }, - { - "id": "031b4b84-1bd8-4c7d-ab23-4d9095f5e963", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employees/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employees", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0c86d10c-34c9-4153-8696-37662dd73430", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employees/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employees", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "b06d3bd8-158a-4383-bf20-7e7512e26a86", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employees/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employees", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "cea16799-fadd-477b-bf24-827d0dba673f", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employees/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employees", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "4fadf63c-e419-4492-8494-2afc5379b6e1", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employees/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employees", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "584e9220-9172-47c8-b761-d3323032e66c", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employees/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employees", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Imports, or Updates, Non-Employee Records", - "id": "da4d66c5-1bda-486e-9900-c50b80c3c640", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "data", - "value": "accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00", - "type": "text", - "description": "(Required) " - } - ] - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload" - ], - "variable": [ - { - "id": "65fc9264-181e-407a-8bf8-38d37fdad435", - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "id": "bdd59ab3-45f6-41c9-b724-99a90cc30148", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This post will import, or update, Non-Employee records found in the CSV.

Requires role context of `idn:nesr:create`" - }, - "response": [ - { - "id": "d6bcda37-774d-4b4b-8cb1-88bb14c9fe8f", - "name": "The CSV was accepted to be bulk inserted now or at a later time.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "description": "(Required) ", - "key": "data", - "value": "accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808568c529c60168cca6f90cffff\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"created\": \"2019-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"status\": \"PENDING\"\n}" - }, - { - "id": "78593884-65aa-4e6a-b7d6-45d6bb812fe2", - "name": "Client Error - Returned if the request body is invalid.\nThe response body will contain the list of specific errors with one on each line.\n", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "description": "(Required) ", - "key": "data", - "value": "accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "dc44eb0a-6333-4284-9f49-ad431ee4b527", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "description": "(Required) ", - "key": "data", - "value": "accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ea1de42a-f391-4fcb-bb6e-9ae324e6bca5", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "description": "(Required) ", - "key": "data", - "value": "accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "66974e78-b8b1-4a8b-8ba2-a891d980ad15", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "description": "(Required) ", - "key": "data", - "value": "accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "99db7864-0cbc-41d6-bea6-53076fb9529d", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "description": "(Required) ", - "key": "data", - "value": "accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "0e976eb8-cc5c-40f9-8363-57d1e0c939eb", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "description": "(Required) ", - "key": "data", - "value": "accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Obtain the status of bulk upload on the source", - "id": "f3eb32ba-2392-43a0-89bc-50f4b4ab307c", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload", - "status" - ], - "variable": [ - { - "id": "8cbec0fe-3e19-47ac-9e7c-22f23bc919b5", - "key": "id", - "value": "eu", - "description": "(Required) Source ID (UUID)" - }, - { - "id": "b827aca8-b11e-4df6-9685-a129b2c3e78b", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.

\nRequires role context of `idn:nesr:read`\n" - }, - "response": [ - { - "id": "d0b52269-2d45-4f95-b1fd-9b6361f98653", - "name": "Status of the newest bulk-upload job, if any.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload", - "status" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source ID (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"status\": \"PENDING\"\n}" - }, - { - "id": "c1a79c41-6c92-4a2d-bd66-9f55c80a7217", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload", - "status" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source ID (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0eb33488-da6a-46e0-b892-6153c663c266", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload", - "status" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source ID (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "1486ba24-69cb-4a31-94b8-b34da72fafde", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload", - "status" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source ID (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "443067a5-2104-4a46-afae-89a36d558bf5", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload", - "status" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source ID (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "a1c98f7c-597b-4aed-8189-4aa177230e1a", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/non-employee-bulk-upload/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "non-employee-bulk-upload", - "status" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source ID (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Exports Source Schema Template", - "id": "74833203-d378-4db6-9fec-47d43bc2341c", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "text/csv" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/schema-attributes-template/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "schema-attributes-template", - "download" - ], - "variable": [ - { - "id": "55a56db8-b960-4cef-8b55-98940bd8b4be", - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "id": "c869f4ca-ad24-4bbb-82fd-bc4bc0543afe", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This requests a download for the Source Schema Template for a provided source.

Requires role context of `idn:nesr:read`" - }, - "response": [ - { - "id": "0c991331-3959-45aa-9cc7-a245a668e3ef", - "name": "Exported Source Schema Template", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/schema-attributes-template/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "schema-attributes-template", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/csv" - } - ], - "cookie": [], - "responseTime": null, - "body": "accountName,firstName,lastName,phone,email,manager,startDate,endDate\n" - }, - { - "id": "c594d85f-5b5c-48b3-9740-8e78d6bdea1f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/schema-attributes-template/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "schema-attributes-template", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "31471881-8b6d-4efb-b0f3-84559f4dc304", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/schema-attributes-template/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "schema-attributes-template", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "f80dcc80-5048-486e-8614-9d9ad8b5d8c2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/schema-attributes-template/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "schema-attributes-template", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1a4e2c60-bae8-45d5-8069-5dc227141f86", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/schema-attributes-template/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "schema-attributes-template", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "49486ff3-16b0-4343-a5db-a70231fcecb6", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/schema-attributes-template/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "schema-attributes-template", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "7922273d-1196-49ce-985c-89b79813777b", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:id/schema-attributes-template/download", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":id", - "schema-attributes-template", - "download" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Source Id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get List of Non-Employee Approval Requests", - "id": "1f6435d5-ae6b-4f65-9e96-d6ca7a567f5f", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals?requested-for=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals" - ], - "query": [ - { - "key": "requested-for", - "value": "eu", - "description": "The identity for whom the request was made. *me* indicates the current user." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)

Filtering is supported for the following fields and operators:

**approvalStatus**: *eq*

*Example:* approvalStatus eq \"PENDING\"" - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)

Sorting is supported for the following fields: **created, modified**" - } - ], - "variable": [ - { - "id": "0020980a-3c17-4187-b2fc-a9283d5d0aa9", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a list of non-employee approval requests.

\nThere are two contextual uses for this endpoint:
\n 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver.
\n 2. The user owns the requested approval. " - }, - "response": [ - { - "id": "76161ecc-bec0-4f5d-a489-66067fb04e02", - "name": "List of approval items.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals?requested-for=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": 1,\n \"comment\": \"enim\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeRequest\": {\n \"id\": \"ea mollit in\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"name\": \"William Smith\"\n }\n }\n },\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": 1,\n \"comment\": \"quis sunt\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeRequest\": {\n \"id\": \"nostrud pariatur nisi ut\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"name\": \"William Smith\"\n }\n }\n }\n]" - }, - { - "id": "5364e0e3-ff01-4bdd-be3b-39fad9d197b8", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals?requested-for=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "63833814-57b8-4ad3-9bf1-781075bd37b6", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals?requested-for=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "79cdf458-97b6-46df-955f-1ba6ef71a2c7", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals?requested-for=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "a5228b75-bb37-4724-9423-1c9a8d79d11c", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals?requested-for=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c1c39bc8-f935-448a-9580-43edd59fc2c0", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals?requested-for=eu&limit=250&offset=0&count=true&filters=eu&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals" - ], - "query": [ - { - "key": "requested-for", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get a non-employee approval item detail", - "id": "b42b847a-d9db-4595-8961-69172c0b89a2", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id?include-detail=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id" - ], - "query": [ - { - "key": "include-detail", - "value": "eu", - "description": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*" - } - ], - "variable": [ - { - "id": "aeccbfa0-3954-465e-a71b-89fed5b20c36", - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "id": "5bdd70ec-8652-4774-92d2-8ae518495178", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Gets a non-employee approval item detail.

There are two contextual uses for this endpoint:
\n 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval.
\n 2. The user owns the requested approval. " - }, - "response": [ - { - "id": "518d89cd-e2f4-4d37-91c7-c38bad0a0538", - "name": "Non-Employee approval item object.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id?include-detail=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id" - ], - "query": [ - { - "key": "include-detail", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": 1,\n \"comment\": \"dese\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeRequest\": {\n \"id\": \"est consectetur aute amet\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"name\": \"William Smith\"\n },\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"nonEmployeeSource\": {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"schemaAttributes\": [\n {\n \"type\": \"TEXT\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n },\n {\n \"type\": \"DATE\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n }\n ]\n },\n \"data\": {\n \"voluptated_\": \"in qui ad proident\"\n },\n \"approvalStatus\": \"REJECTED\",\n \"comment\": \"est laborum aute aliquip\",\n \"completionDate\": \"2020-03-24T11:11:41.139-05:00\",\n \"startDate\": \"2020-03-24\",\n \"endDate\": \"2021-03-25\",\n \"modified\": \"2020-03-24T11:11:41.139-05:00\",\n \"created\": \"2020-03-24T11:11:41.139-05:00\"\n }\n}" - }, - { - "id": "6d26e5ae-3f34-4001-958b-d5fa89276317", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id?include-detail=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id" - ], - "query": [ - { - "key": "include-detail", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "90cbff41-40de-4b40-82a7-9c74eaa93efd", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id?include-detail=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id" - ], - "query": [ - { - "key": "include-detail", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "07e0e383-ff8d-45a0-9d7b-62e7c08142e9", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id?include-detail=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id" - ], - "query": [ - { - "key": "include-detail", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "4c6392e9-5343-4df0-bf0f-b1bb9643d6bd", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id?include-detail=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id" - ], - "query": [ - { - "key": "include-detail", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "dbdc410e-1d64-46ca-ab80-a5182fc6963e", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id?include-detail=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id" - ], - "query": [ - { - "key": "include-detail", - "value": "eu" - } - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Approve a Non-Employee Request", - "id": "6bb39f8f-b7bc-4c8f-84bc-7043772a3398", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"enim esse Ut\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "approve" - ], - "variable": [ - { - "id": "02ce0d9e-2288-4066-87a3-3d4409aa7baf", - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "id": "7aa2bb87-2757-4e4d-938c-7854920ad437", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Approves a non-employee approval request and notifies the next approver.

The current user must be the requested approver." - }, - "response": [ - { - "id": "8ee8d148-1ec2-408b-afeb-4eec982a34ea", - "name": "Non-Employee approval item object.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"enim esse Ut\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "approve" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": 1,\n \"comment\": \"ipsum aute pariatur cupidatat\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeRequest\": {\n \"id\": \"eiusmod proident pariatur sit culpa\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"name\": \"William Smith\"\n }\n }\n}" - }, - { - "id": "166e4245-c5ef-4345-8a3d-77bd890668df", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"enim esse Ut\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "approve" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "5937013b-cd93-48c0-8b68-6a96476f759d", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"enim esse Ut\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "approve" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ee80a483-e363-4f41-92d3-07445c16acf0", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"enim esse Ut\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "approve" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "223d0455-fa29-422a-a21d-089b8e96bdc8", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"enim esse Ut\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "approve" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "b63a6d75-28e9-457e-8d78-6e6fa42a122a", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"enim esse Ut\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/approve", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "approve" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Reject a Non-Employee Request", - "id": "d85147f2-9c14-4375-8d60-7474a549a45a", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"aliqua sunt\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "reject" - ], - "variable": [ - { - "id": "2de91637-2453-4d23-9843-580af22c1575", - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "id": "1b04256f-e892-455c-97bc-ada6492f5c58", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint will reject an approval item request and notify user.

The current user must be the requested approver." - }, - "response": [ - { - "id": "0816f67e-68f9-457a-b1b7-2cb34d6df306", - "name": "Non-Employee approval item object.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"aliqua sunt\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "reject" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": 1,\n \"comment\": \"ipsum aute pariatur cupidatat\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeRequest\": {\n \"id\": \"eiusmod proident pariatur sit culpa\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"name\": \"William Smith\"\n }\n }\n}" - }, - { - "id": "d9e09f24-e3dd-458d-965b-04d0252e76e3", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"aliqua sunt\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "reject" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "cd8efd2a-b80d-41b5-8996-e005a4dad35e", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"aliqua sunt\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "reject" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "47e272f2-4ca1-4ca5-9404-5b25f86155ea", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"aliqua sunt\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "reject" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "5e438105-df46-4ee1-ab8c-b8d7f4efe758", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"aliqua sunt\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "reject" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "5da6a92f-19a9-4072-af45-4871d03758bd", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"comment\": \"aliqua sunt\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/:id/reject", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - ":id", - "reject" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) Non-Employee approval item id (UUID)" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Summary of Non-Employee Approval Requests", - "id": "15f4caac-1b1d-4586-b12a-285f840795e7", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - "summary", - ":requested-for" - ], - "variable": [ - { - "id": "d352d86f-1308-4bab-92e3-170d841696cf", - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "id": "bfc8cb53-0148-43a4-a335-fd34b33be388", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This request will retrieve a summary of non-employee approval requests.

There are two contextual uses for the `requested-for` path parameter:
\n 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id.
\n 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her." - }, - "response": [ - { - "id": "5f13aa59-da14-45f2-b873-a3d0d02b1a9f", - "name": "summary of non-employee approval requests", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"approved\": -62837425.518178016,\n \"pending\": -76061148.90341295,\n \"rejected\": -8605986.908982947\n}" - }, - { - "id": "5bfadc87-6e3f-4867-a1f6-e5ad5381fbc0", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "ab64eddb-f96c-4a50-902d-0b3dd88595fb", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "b0c122f1-111e-4374-88b0-885d5c372930", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "36c4557a-9421-4bfe-b1a9-121823920cb8", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "ed674ceb-8c1c-4775-8534-f77c85290943", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-approvals/summary/:requested-for", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-approvals", - "summary", - ":requested-for" - ], - "variable": [ - { - "key": "requested-for", - "value": "eu", - "description": "(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "List Schema Attributes Non-Employee Source", - "id": "eb73e8f9-e601-4788-baeb-11fc1b781ee3", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "id": "8bb64c87-0429-4715-881d-7a5d8f5cc2cc", - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "id": "e7f22505-6a6c-4d80-abe2-82584b256e00", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.

\nRequires role context of `idn:nesr:read` or the user must be an account manager of the source." - }, - "response": [ - { - "id": "9972da2b-b310-40ca-b606-6c6914493450", - "name": "A list of Schema Attributes", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"type\": \"DATE\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n },\n {\n \"type\": \"DATE\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n }\n]" - }, - { - "id": "25d372f2-1137-4138-b446-7513b9e2dc31", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "4b7be0d7-35a7-4513-9aad-73842ee191d1", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "0b8f7562-2753-4603-858f-01f284865926", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "36fd3371-108c-4157-8ee0-f48f7d7a1287", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "2856bf90-3a56-42d6-a75e-2db4af5f343e", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create a new Schema Attribute for Non-Employee Source", - "id": "79f00418-cdcf-434a-9afe-9e3c688b5a55", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "id": "5ac08a5f-8cf1-43ba-be40-8101402f97c3", - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "id": "d5bec095-2bdf-48f1-bffb-074b73bcaae6", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response.

\nRequires role context of `idn:nesr:create`" - }, - "response": [ - { - "id": "b850953e-339b-4e24-a29f-8b7900df07fe", - "name": "Schema Attribute created.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"type\": \"IDENTITY\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}" - }, - { - "id": "00f36e4a-6d9d-4027-88e7-3879bb0fbe02", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "8e20c8c0-5e32-47c2-b3c2-fa79925a4557", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "1de19f4a-90cd-42e3-8f63-031e2562e5f3", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "06156bcf-3071-4e4a-b02a-c7b5439aa538", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "ca3a3eb5-99b0-4e37-900f-cafec0ba2616", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"TEXT\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete all custom schema attributes for Non-Employee Source", - "id": "04c3fd1c-8bd2-4546-ba01-9bf535f18f67", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "id": "de7aed27-c286-46f5-acf9-40e08cad7851", - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "id": "21ad14af-85b3-4d94-bb87-b507472e9785", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point deletes all custom schema attributes for a non-employee source.

Requires role context of `idn:nesr:delete`" - }, - "response": [ - { - "id": "331798ce-78c4-452d-a8ce-291ecf8af2d0", - "name": "All custon Schema Attributes were successfully deleted.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "5d820240-c0d4-43a2-9b2f-0aac33b6c9fd", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "886c7f7e-3b13-4351-8485-a669c63ecf87", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "011d5524-c73e-45ab-ac8d-a5eca4a1217d", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "3186dbc3-ac7f-4dd3-ba87-d6885462b1a6", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "373a48be-9a4f-4569-ad0e-8acc05f2d632", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes" - ], - "variable": [ - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Schema Attribute Non-Employee Source", - "id": "9f0e26e6-dbe7-4aa7-b365-b16f414ba81e", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "id": "44482fc1-2c83-4dc6-9e22-a4625e5f8b55", - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "id": "2a7a1a9a-5c9a-4c1d-9e0b-1dd9b2a950e1", - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "id": "3c725ce8-27c3-4119-a7e2-de48ba0e0688", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API gets a schema attribute by Id for the specified Non-Employee SourceId.

Requires role context of `idn:nesr:read` or the user must be an account manager of the source." - }, - "response": [ - { - "id": "ed90d364-5c1f-49c1-ae54-ccd092675b13", - "name": "The Schema Attribute", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"type\": \"IDENTITY\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}" - }, - { - "id": "fd0467a8-e6b1-4599-9118-0887e0a1550d", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "d99f3031-4419-4766-99e7-25c2330c47fd", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "7dcf7274-1d06-43e7-b293-da3f48c4e3cd", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c7f515e7-0634-4508-b723-1da6f7eda9d1", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Patch a Schema Attribute for Non-Employee Source", - "id": "0ba56403-0dde-40e9-8be1-9079a49dbd2b", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "id": "91163127-eec9-42e0-8ed4-8246bd1e3911", - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "id": "cc323827-eb73-4c26-ac1c-928989eac5fb", - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "id": "5b5f15d0-4bef-4034-90a6-f3252cf9ae47", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point patches a specific schema attribute for a non-employee SourceId.

\nRequires role context of `idn:nesr:update`\n" - }, - "response": [ - { - "id": "05c30542-ceed-4d0d-be2b-588c0bf0fba8", - "name": "The Schema Attribute was successfully patched.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"type\": \"IDENTITY\",\n \"technicalName\": \"account.name\",\n \"label\": \"Account Name\",\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}" - }, - { - "id": "df313d1b-afcb-4b10-9ea0-6483bc9f5e92", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "878902a2-0e84-44ab-a4a4-b901974800c5", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "99763076-3959-4fdf-92f3-518ef9363f93", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1638f0bc-8e55-4c9c-92eb-b3e2f322fff2", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "c9e2884c-b8b8-4ec3-8fb3-17f4edbb991c", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "e398a669-6fe0-4636-bad9-8f4ce792eec4", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete a Schema Attribute for Non-Employee Source", - "id": "74cd5a3f-505d-4e4f-9308-4c04a6bb6dd2", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "id": "05b45959-c3ee-4605-8450-9758958b8523", - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "id": "5f8668ef-8b73-4405-a8e8-99a5f7a45d32", - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "id": "5b6464c0-9335-4fcb-8bd5-b4bde0a3209a", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point deletes a specific schema attribute for a non-employee source.

\nRequires role context of `idn:nesr:delete`\n" - }, - "response": [ - { - "id": "d61861ad-e6f6-4385-b00a-5c0003394240", - "name": "The Schema Attribute was successfully deleted.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "fba8e303-206a-4d27-8520-ef7e0a05b7bf", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b9c36384-84e7-447f-8716-72eded62a23d", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "a1c3c825-9c32-4e44-bd7b-02c1c48176ed", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1bc501b6-362e-4c97-9955-a8dee3c7928e", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "461e93d3-63b2-476c-b31b-812b3bf3544c", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/non-employee-sources/:sourceId/schema-attributes/:attributeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "non-employee-sources", - ":sourceId", - "schema-attributes", - ":attributeId" - ], - "variable": [ - { - "key": "attributeId", - "value": "eu", - "description": "(Required) The Schema Attribute Id (UUID)" - }, - { - "key": "sourceId", - "value": "eu", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "34731157-8407-4e5c-98ee-df12d556b124", - "description": "Use this API to implement non-employee lifecycle management functionality. \nWith this functionality in place, administrators can create non-employee records and configure them for use in their organizations. \nThis allows organizations to provide secure access to non-employees and control that access. \n\nThe 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. \nOrganizations can track non-employees' access and activity in IdentityNow by creating and maintaining non-employee sources. \nOrganizations can have a maximum of 50 non-employee sources. \n\nBy using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following:\n\n- SailPoint is not responsible for storing sensitive data. \nYou may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in IdentityNow.\n\n- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts.\n\nTo manage non-employees in IdentityNow, administrators must create a non-employee source and add accounts to the source. \n\nTo create a non-employee source in IdentityNow, administrators must use the Admin panel to go to Connections > Sources.\nThey must then specify 'Non-Employee' in the 'Source Type' field. \nSee [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources.\n\nTo add accounts to a non-employee source in IdentityNow, administrators can select the non-employee source and add the accounts. \nThey can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. \n\nAdministrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. \nTo add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. \nSee [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources.\n\nOnce administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. \n\nRefer to the following link for more information about non-employee lifecycle management:\n" - }, - { - "name": "OAuth Clients", - "item": [ - { - "name": "List OAuth Clients", - "id": "2fa148f1-47b0-4ead-99f7-7d6cb008f7c4", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "id": "8343cbd5-5a00-42ed-85c8-6a44dd6353e3", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a list of OAuth clients.\nRequest will require the following security scope:\n- 'idn:oathkeeper-client-list:read'" - }, - "response": [ - { - "id": "e9f63e16-2b37-493d-8626-41b01ea7f734", - "name": "List of OAuth clients.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"proident ut Duis\",\n \"refreshTokenValiditySeconds\": \"ut ad\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"enabled\": true,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false,\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"dolor magna sed\",\n \"refreshTokenValiditySeconds\": \"par\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"enabled\": true,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false,\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n }\n]" - }, - { - "id": "30b60314-5532-425c-ad55-8b2abe1dca04", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "46134bad-76b7-416a-926e-58ff9d8be355", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "e2f6f381-d07f-40d1-b363-33117c2cdbbc", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "0396cca1-bd51-4199-b46b-17818deca2d4", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "daac8687-f0b2-4d83-8ef1-934e191659f3", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create OAuth Client", - "id": "1d468dbb-9751-4695-82fe-d798281d9116", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"dolore ea\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": true,\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"refreshTokenValiditySeconds\": \"proident sed\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "id": "5b2e1c51-3ab8-4d0e-a973-38f1005534df", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This creates an OAuth client.\nRequest will require the following security scope:\n- 'idn:oathkeeper-client:create' - 'idn:oathkeeper-internal-client:create'" - }, - "response": [ - { - "id": "6bb1b717-7ec4-4f0d-bd77-9d929709ec30", - "name": "Request succeeded.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"officia\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": true,\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"refreshTokenValiditySeconds\": \"Lorem dolor\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"secret\": \"5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3\",\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"minim eiusmod dolor ex dolor\",\n \"refreshTokenValiditySeconds\": \"ullamco eiusmod exercitation non\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"enabled\": true,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false,\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n}" - }, - { - "id": "0cc1f670-48bc-44a2-882a-cc1964f0ac4a", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"officia\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": true,\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"refreshTokenValiditySeconds\": \"Lorem dolor\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "93bb2f80-3136-40a7-b208-53b8d442f478", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"officia\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": true,\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"refreshTokenValiditySeconds\": \"Lorem dolor\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "c649b3ec-c5f7-477d-960e-41e18db8a756", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"officia\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": true,\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"refreshTokenValiditySeconds\": \"Lorem dolor\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "98458961-1b3f-43ea-8a5e-a0700074c389", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"officia\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": true,\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"refreshTokenValiditySeconds\": \"Lorem dolor\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "d913d2a6-2528-4e9e-a3a4-01547b258434", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"officia\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": true,\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"refreshTokenValiditySeconds\": \"Lorem dolor\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get OAuth Client", - "id": "f5c26968-f957-460d-84ba-dc8fd101a192", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "id": "da87e4c7-21dd-4c47-9ebf-f6b5e90ed51e", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "id": "12237e34-5616-4d1d-b2cf-9cf26ed38718", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets details of an OAuth client.\nRequest will require the following security scope:\n- 'idn:oathkeeper-client:read'" - }, - "response": [ - { - "id": "75d970c9-6c89-4ca3-86d9-c3571a6c19b9", - "name": "Request succeeded.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"ut\",\n \"refreshTokenValiditySeconds\": \"voluptate dolor ad eu\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"enabled\": true,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false,\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n}" - }, - { - "id": "a60b7aa2-d89d-49cd-9be3-1baf439b1146", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "9f69fa57-76ea-470c-ac83-a993159fa65b", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "726123c0-0f85-47c0-8c7e-8f78a3193058", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "5d5206d1-4889-46ba-94e6-56d4fbf23ac9", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "aa5838d0-6210-4e28-84ee-b7fd53d43d78", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c736c2cf-d160-49a8-a4f1-eea2daeae302", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete OAuth Client", - "id": "b224ba3b-6035-4375-baf9-f846f6b91cba", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "id": "cc1eb305-c274-4c0a-a8e5-d0a91eebe2b3", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "id": "b83083f9-b450-48bf-b193-41fd71289e43", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This deletes an OAuth client.\nRequest will require the following security scopes:\n- 'idn:oathkeeper-client:delete' - 'idn:oathkeeper-internal-client:delete'" - }, - "response": [ - { - "id": "5503736f-7a22-4ee1-b4a7-156f188a2b9c", - "name": "No content.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "dc6e50c6-4f32-44c2-83f7-23dd9f12b36f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "6da2027e-babb-4396-8bf8-b6441e120361", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "21222504-f09d-47b5-ba3a-37cfa22da489", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "ed4c4f00-9d90-40cc-8c79-4c99791c1da9", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "448108ea-e84a-4771-9192-8a916b46cfd0", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "1bd0d79f-93df-4704-9fc2-583c65b16673", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Patch OAuth Client", - "id": "6e01ae74-55b4-4b67-8125-dab27804c0ab", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "id": "c60c6085-4419-4be5-9f4c-b783767e3359", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "id": "9533345c-715e-4b62-b75f-270bfcb9aee7", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This performs a targeted update to the field(s) of an OAuth client.\nRequest will require a security scope of\n'idn:oathkeeper-client:update'" - }, - "response": [ - { - "id": "de959a30-913b-43e9-994d-2c6fc894dc70", - "name": "Indicates the PATCH operation succeeded, and returns the OAuth client's new representation.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": \"ut\",\n \"refreshTokenValiditySeconds\": \"voluptate dolor ad eu\",\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"enabled\": true,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false,\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n}" - }, - { - "id": "ee50ef27-aa61-44fd-8f40-9958425f79d7", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e1cc2579-2c32-477e-8d0b-54df5f46035f", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "9af7cb9b-b86c-4f36-9d60-893f12f5bb9e", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "4748f716-821e-4e9f-9f08-91b73fd59dec", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "ec9377f8-0c7f-44c5-958c-c1a158347ea8", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "05b7fa00-ede7-4430-a775-60acaa5ac257", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object],[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/oauth-clients/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "oauth-clients", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The OAuth client id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "137929f6-f7f2-4034-a2f0-82d203666709", - "description": "Use this API to implement OAuth client functionality. \nWith this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the IdentityNow REST API.\nSee [Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information about OAuth and how it works with the IdentityNow REST API. \n" - }, - { - "name": "Password Management", - "item": [ - { - "name": "Query Password Info", - "id": "ce4db6ab-512e-45c7-a1e7-5461b26f93bc", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userName\": \"Abby.Smith\",\n \"sourceName\": \"My-AD\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/query-password-info", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "query-password-info" - ], - "variable": [ - { - "id": "080c24b4-430d-4e22-9c34-eda98a4f9e26", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API is used to query password related information. A token with API authority is required to call this API." - }, - "response": [ - { - "id": "a8f857dc-b8c3-4ccc-a875-90a5141874ee", - "name": "Reference to the password info.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userName\": \"Abby.Smith\",\n \"sourceName\": \"My-AD\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/query-password-info", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "query-password-info" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"identityId\": \"2c918085744fec4301746f9a5bce4605\",\n \"sourceId\": \"2c918083746f642c01746f990884012a\",\n \"publicKeyId\": \"N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh\",\n \"publicKey\": \"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB\",\n \"accounts\": [\n {\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"accountName\": \"Abby.Smith\"\n },\n {\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"accountName\": \"Abby.Smith\"\n }\n ],\n \"policies\": [\n \"passwordRepeatedChar is 3\",\n \"passwordMinAlpha is 1\",\n \"passwordMinLength is 5\",\n \"passwordMinNumeric is 1\"\n ]\n}" - }, - { - "id": "a473735d-f6a9-4e20-9d3f-178a7df1ea21", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userName\": \"Abby.Smith\",\n \"sourceName\": \"My-AD\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/query-password-info", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "query-password-info" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "95cf96dc-03f4-434d-9cfb-d46b91ee51f9", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userName\": \"Abby.Smith\",\n \"sourceName\": \"My-AD\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/query-password-info", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "query-password-info" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "9d386641-d8d0-462f-b78f-7e210cf44d51", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userName\": \"Abby.Smith\",\n \"sourceName\": \"My-AD\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/query-password-info", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "query-password-info" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b4165957-1f45-4644-9d92-d3a348c0b01d", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userName\": \"Abby.Smith\",\n \"sourceName\": \"My-AD\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/query-password-info", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "query-password-info" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "289107c6-acd6-4cbe-a633-69b94135061b", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userName\": \"Abby.Smith\",\n \"sourceName\": \"My-AD\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/query-password-info", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "query-password-info" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Set Identity's Password", - "id": "a614a5ca-221e-43e8-9a71-65f061c90fd9", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"identityId\": \"8a807d4c73c545510173c545f0a002ff\",\n \"encryptedPassword\": \"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==\",\n \"publicKeyId\": \"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2\",\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"sourceId\": \"8a807d4c73c545510173c545d4b60246\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/set-password", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "set-password" - ], - "variable": [ - { - "id": "d0a623aa-70b9-4842-9c25-26cc3cebb006", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API is used to set a password for an identity. The password can only be set by the actual identity owner or by a trusted API client application." - }, - "response": [ - { - "id": "e5142a0a-b9b7-45e6-be8e-816d3706be6e", - "name": "Reference to the password change.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"identityId\": \"8a807d4c73c545510173c545f0a002ff\",\n \"encryptedPassword\": \"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==\",\n \"publicKeyId\": \"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2\",\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"sourceId\": \"8a807d4c73c545510173c545d4b60246\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/set-password", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "set-password" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"requestId\": \"089899f13a8f4da7824996191587bab9\",\n \"state\": \"IN_PROGRESS\"\n}" - }, - { - "id": "7d9543de-eb9c-466e-9ed7-f2c21bb99eca", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"identityId\": \"8a807d4c73c545510173c545f0a002ff\",\n \"encryptedPassword\": \"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==\",\n \"publicKeyId\": \"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2\",\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"sourceId\": \"8a807d4c73c545510173c545d4b60246\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/set-password", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "set-password" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "8e1fa954-5bb8-4b30-9079-4341a08526e2", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"identityId\": \"8a807d4c73c545510173c545f0a002ff\",\n \"encryptedPassword\": \"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==\",\n \"publicKeyId\": \"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2\",\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"sourceId\": \"8a807d4c73c545510173c545d4b60246\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/set-password", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "set-password" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "25ec1026-ebe2-4fa2-8a91-81e6addd4aa2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"identityId\": \"8a807d4c73c545510173c545f0a002ff\",\n \"encryptedPassword\": \"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==\",\n \"publicKeyId\": \"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2\",\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"sourceId\": \"8a807d4c73c545510173c545d4b60246\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/set-password", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "set-password" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "59a05fd9-20cf-4955-a3e8-f6a2f1e0935c", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"identityId\": \"8a807d4c73c545510173c545f0a002ff\",\n \"encryptedPassword\": \"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==\",\n \"publicKeyId\": \"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2\",\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"sourceId\": \"8a807d4c73c545510173c545d4b60246\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/set-password", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "set-password" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "f109f8d1-aa27-447a-b04e-b0f5ea667491", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"identityId\": \"8a807d4c73c545510173c545f0a002ff\",\n \"encryptedPassword\": \"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==\",\n \"publicKeyId\": \"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2\",\n \"accountId\": \"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com\",\n \"sourceId\": \"8a807d4c73c545510173c545d4b60246\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/set-password", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "set-password" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Password Change Request Status", - "id": "bd5ad9ce-0035-4038-88ca-b27e7364e776", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/password-change-status/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "password-change-status", - ":id" - ], - "variable": [ - { - "id": "c4022cc1-c80c-474b-81d5-5dbbee7ddc67", - "key": "id", - "value": "089899f13a8f4da7824996191587bab9", - "description": "(Required) Password change request ID" - }, - { - "id": "91b67b5a-25a4-49b4-bf3b-9a65b509b3e2", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API." - }, - "response": [ - { - "id": "7b220010-e0c9-4fad-b04b-2eb34c80fd55", - "name": "Status of the password change request", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/password-change-status/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "password-change-status", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "089899f13a8f4da7824996191587bab9", - "description": "(Required) Password change request ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"requestId\": \"089899f13a8f4da7824996191587bab9\",\n \"state\": \"IN_PROGRESS\",\n \"errors\": [\n \"The password change payload is invalid\"\n ],\n \"sourceIds\": [\n \"2c918083746f642c01746f990884012a\"\n ]\n}" - }, - { - "id": "61c2656e-c340-41d1-a91c-c6930c6d496b", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/password-change-status/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "password-change-status", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "089899f13a8f4da7824996191587bab9", - "description": "(Required) Password change request ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e2d3af5c-2311-4524-b82f-7078557fbbcd", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/password-change-status/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "password-change-status", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "089899f13a8f4da7824996191587bab9", - "description": "(Required) Password change request ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "5b5e75ae-873e-4a67-8e18-0cb0e7904d89", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/password-change-status/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "password-change-status", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "089899f13a8f4da7824996191587bab9", - "description": "(Required) Password change request ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "8d372296-8381-4710-bc28-733e9f69a37c", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/password-change-status/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "password-change-status", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "089899f13a8f4da7824996191587bab9", - "description": "(Required) Password change request ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "7a67b628-0171-4f38-b9f3-e68d7b97cfcd", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/password-change-status/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "password-change-status", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "089899f13a8f4da7824996191587bab9", - "description": "(Required) Password change request ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "83d1f8c0-7b10-42fb-8d9f-b267a4f621d4", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/password-change-status/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "password-change-status", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "089899f13a8f4da7824996191587bab9", - "description": "(Required) Password change request ID" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "4d21b0b2-8738-471b-a8a1-0cb65f2af084", - "description": "Use this API to implement password management functionality. \nWith this functionality in place, users can manage their identity passwords for all their applications.\n\nIn IdentityNow, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. \nPassword Manager lists the user's identity's applications, possibly grouped to share passwords. \nUsers can then select 'Change Password' to update their passwords. \n\nGrouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. \nPassword Manager may list the applications and sources in the following groups:\n\n- Password Group: This refers to a group of applications that share a password. \nFor example, a user can use the same password for Google Drive, Google Mail, and YouTube. \nUpdating the password for the password group updates the password for all its included applications.\n\n- Multi-Application Source: This refers to a source with multiple applications that share a password. \nFor example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. \nUpdating the password for the multi-application source updates the password for all its included applications. \n\n- Applications: These are applications that do not share passwords with other applications.\n\nAn organization may require some authentication for users to update their passwords. \nUsers may be required to answer security questions or use a third-party authenticator before they can confirm their updates. \n\nRefer to the following link for more information about password management:\n" - }, - { - "name": "Personal Access Tokens", - "item": [ - { - "name": "List Personal Access Tokens", - "id": "83e34172-bcae-49f4-9fd3-3295d22c4c88", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens?owner-id=2c9180867b50d088017b554662fb281e", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "query": [ - { - "key": "owner-id", - "value": "2c9180867b50d088017b554662fb281e", - "description": "The identity ID of the owner whose personal access tokens should be listed.
If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read'

If an actual owner ID or if the owner-id parameter is omitted in the request,
the caller should have the following right: 'idn:all-personal-access-tokens:read'.

If the caller has the following right, then managed personal access tokens associated with owner-id
will be retrieved: 'idn:managed-personal-access-tokens:read'" - } - ], - "variable": [ - { - "id": "a8c98b50-c6d4-4a9e-bab2-cfe18b33c761", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a collection of personal access tokens associated with the optional owner-id.
query parameter. If the owner-id query parameter is omitted, all personal access tokens
for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.

Any of the following rights are required to access this resource:
    \n
  • idn:my-personal-access-tokens:read
    • \n
  • idn:all-personal-access-tokens:read
    • \n
  • idn:managed-personal-access-tokens:read
    • \n
" - }, - "response": [ - { - "id": "aaf3d76d-aaaf-415c-b02d-2254e4317586", - "name": "List of personal access tokens.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens?owner-id=2c9180867b50d088017b554662fb281e", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "query": [ - { - "key": "owner-id", - "value": "2c9180867b50d088017b554662fb281e" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"86f1dc6fe8f54414950454cbb11278fa\",\n \"name\": \"NodeJS Integration\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n },\n {\n \"id\": \"86f1dc6fe8f54414950454cbb11278fa\",\n \"name\": \"NodeJS Integration\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n }\n]" - }, - { - "id": "5ac87df4-b546-4668-b6c8-b710f9743d86", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens?owner-id=2c9180867b50d088017b554662fb281e", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "query": [ - { - "key": "owner-id", - "value": "2c9180867b50d088017b554662fb281e" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "142aecb9-99c6-43f9-b6f3-018c5b773ab5", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens?owner-id=2c9180867b50d088017b554662fb281e", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "query": [ - { - "key": "owner-id", - "value": "2c9180867b50d088017b554662fb281e" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "22663d02-0bec-421b-9d5f-5de26f479c64", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens?owner-id=2c9180867b50d088017b554662fb281e", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "query": [ - { - "key": "owner-id", - "value": "2c9180867b50d088017b554662fb281e" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "556294b1-ca93-4b7d-82ef-c5039ac06dac", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens?owner-id=2c9180867b50d088017b554662fb281e", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "query": [ - { - "key": "owner-id", - "value": "2c9180867b50d088017b554662fb281e" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "b0fa1b71-395e-41ac-b109-c034ded93bd1", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens?owner-id=2c9180867b50d088017b554662fb281e", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "query": [ - { - "key": "owner-id", - "value": "2c9180867b50d088017b554662fb281e" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create Personal Access Token", - "id": "6efcbe86-4a59-4363-b7a2-db7dc3f003e8", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"NodeJS Integration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/personal-access-tokens", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "variable": [ - { - "id": "3e77739f-a3be-401c-ac2e-f5a00a453058", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This creates a personal access token.

Any of the following rights are required to access this resource:
    \n
  • idn:my-personal-access-tokens:create
    • \n
  • idn:all-personal-access-tokens:create
    • \n
  • idn:managed-personal-access-tokens:create
    • \n
" - }, - "response": [ - { - "id": "6f5fa8cf-9812-4f3f-a98a-90ad2ac93f97", - "name": "Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"NodeJS Integration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/personal-access-tokens", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"86f1dc6fe8f54414950454cbb11278fa\",\n \"secret\": \"1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9\",\n \"name\": \"NodeJS Integration\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}" - }, - { - "id": "5132b132-58b4-4b39-9568-b103b8c126f2", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"NodeJS Integration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/personal-access-tokens", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "f08542b0-d846-402f-b4ff-ce97f70ab045", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"NodeJS Integration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/personal-access-tokens", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "a86ad6f3-9956-4a92-80c2-f199a543726a", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"NodeJS Integration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/personal-access-tokens", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "41b0155c-0e5f-4cd8-8fee-a931c5e4c6f9", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"NodeJS Integration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/personal-access-tokens", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "18641681-19cb-4457-aed4-aae5e382f692", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"NodeJS Integration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/personal-access-tokens", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Personal Access Token", - "id": "804c7901-cd8f-4d68-8a8e-72202525e402", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens", - ":id" - ], - "variable": [ - { - "id": "03b21838-ddc8-4dcc-8769-f8baa4e73656", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The personal access token id" - }, - { - "id": "ef43f451-b2c4-42e4-b585-a87dfdd492a0", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This deletes a personal access token

Any of the following rights are required to access this resource:
    \n
  • idn:my-personal-access-tokens:delete
    • \n
  • idn:all-personal-access-tokens:delete
    • \n
  • idn:managed-personal-access-tokens:delete
    • \n
" - }, - "response": [ - { - "id": "911edaf1-79f7-4146-a896-76a13cad66f3", - "name": "No content.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The personal access token id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "b1588468-c2e8-4acb-880b-27582831d8ed", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The personal access token id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b31f229c-adc6-4582-a9df-aa301b521ec1", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The personal access token id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "fbbb2a60-06bb-44b4-b0d2-fd5425cfe2bb", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The personal access token id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "871b4d03-1bd2-4fa2-8fa9-2f711d3f9d36", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The personal access token id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "34cbac02-a604-476e-a254-84f07f08a231", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The personal access token id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "88d2f2a5-3c00-4007-98cd-299adfa078d5", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/personal-access-tokens/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "personal-access-tokens", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The personal access token id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "e40d2bc9-6b4e-42fb-9104-fc1e54c67af4", - "description": "Use this API to implement personal access token (PAT) functionality. \nWith this functionality in place, users can use PATs as an alternative to passwords for authentication in IdentityNow. \n\nPATs embed user information into the client ID and secret. \nThis replaces the API clients' need to store and provide a username and password to establish a connection, improving IdentityNow organizations' integration security. \n\nIn IdentityNow, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. \nThey must then provide a description about the token's purpose. \nThey can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. \n\nRefer to the following link for more information about PATs:\n" - }, - { - "name": "Public Identities", - "item": [ - { - "name": "Get a list of public identities", - "id": "0393479f-9689-4bbe-9341-b16674d5df71", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities?limit=250&offset=0&count=true&filters=eu&add-core-filters=false&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**alias**: *eq, sw*\n\n**email**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*" - }, - { - "key": "add-core-filters", - "value": "false", - "description": "If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*:\n - Should be either correlated or protected.\n - Should not be \"spadmin\" or \"cloudadmin\".\n - uid should not be null.\n - lastname should not be null.\n - email should not be null." - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**" - } - ], - "variable": [ - { - "id": "c8c48cb0-a1d4-457e-90e6-761acaaf9c09", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "response": [ - { - "id": "851d756d-5d46-4e85-ab90-20863157147d", - "name": "A list of public identity objects.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities?limit=250&offset=0&count=true&filters=eu&add-core-filters=false&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "add-core-filters", - "value": "false" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180857182305e0171993735622948\",\n \"name\": \"Alison Ferguso\",\n \"alias\": \"alison.ferguso\",\n \"email\": \"alison.ferguso@acme-solar.com\",\n \"status\": \"Active\",\n \"manager\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n },\n \"attributes\": [\n {\n \"key\": \"phone\",\n \"name\": \"Phone\",\n \"value\": \"5125551234\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\",\n \"value\": \"US\"\n }\n ]\n },\n {\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\",\n \"alias\": \"thomas.edison\",\n \"email\": \"thomas.edison@acme-solar.com\",\n \"status\": \"Active\",\n \"manager\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c918086676d3e0601677611dbde220f\",\n \"name\": \"Mister Manager\"\n },\n \"attributes\": [\n {\n \"key\": \"phone\",\n \"name\": \"Phone\",\n \"value\": \"5125554321\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\",\n \"value\": \"US\"\n }\n ]\n }\n]" - }, - { - "id": "45182cbd-04ef-46f2-8ce3-ad51e6d03b62", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities?limit=250&offset=0&count=true&filters=eu&add-core-filters=false&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "add-core-filters", - "value": "false" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "a56949b3-7577-42f8-8fc4-79d7aaa0a66b", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities?limit=250&offset=0&count=true&filters=eu&add-core-filters=false&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "add-core-filters", - "value": "false" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "5f025236-cf56-4ffe-a5f3-49a50e2477d6", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities?limit=250&offset=0&count=true&filters=eu&add-core-filters=false&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "add-core-filters", - "value": "false" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "6e89427a-0d3e-48c9-9e91-9e3251191809", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities?limit=250&offset=0&count=true&filters=eu&add-core-filters=false&sorters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "add-core-filters", - "value": "false" - }, - { - "key": "sorters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "6b49aba1-4e58-4a58-8d8f-72b35bd25eb3", - "description": "Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/idn/api/v3/public-identities-config) to enable non-administrators to view identities' publicly visible attributes. \nWith this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. \nThis can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.\n" - }, - { - "name": "Public Identities Config", - "item": [ - { - "name": "Get the Public Identities Configuration", - "id": "020e374a-3edc-4b5e-b683-0173f6161aac", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "id": "934f73b9-c10a-4c61-8078-0089c1c796d1", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "67149fcb-dcb0-4f56-b066-429ee137fe85", - "name": "Request succeeded.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}" - }, - { - "id": "ca3971de-042c-446c-aa50-13fdd980f8a2", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "1ca0d648-b53f-46e4-b26e-06a2d07acb72", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1cd799d2-9ad3-46c0-8078-e0c0dfd980d2", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "289a21a2-0f4a-4539-a242-1b064395b2ec", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update the Public Identities Configuration", - "id": "3a4f1703-9219-40fe-b9f3-f3a7d8bd3f93", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "id": "0b9cd37d-4054-4d0e-9407-92134fde143d", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "8e6b8d85-417a-496c-aced-847eada98f3c", - "name": "Request succeeded.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}" - }, - { - "id": "78f16604-9dea-44a8-95e3-7866b8463cb6", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "588ea19f-c418-4c9a-89f0-b7105525e5a6", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ba95a9cf-52bd-4122-97e6-c131460bd9fa", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "d519ee00-f40d-4158-b04b-de6a46b7fcf4", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "61086181-a4a6-4142-af78-609e95fbbefc", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": [\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"country\",\n \"name\": \"Country\"\n }\n ],\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/public-identities-config", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "public-identities-config" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "2cd6b922-063d-4ddd-8fe6-b04a07691277", - "description": "Use this API to implement public identity configuration functionality. \nWith this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. \nThis can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.\n\nBy default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. \nHowever, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc.\nAdministrators can use this API to make those necessary identity attributes public to non-administrators. \n\nFor example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. \nIf an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/idn/api/v3/update-public-identity-config) to make the \"department\" attribute public, the approver can see the department and make a decision without requesting any more information.\n" - }, - { - "name": "Requestable Objects", - "item": [ - { - "name": "Requestable Objects List", - "id": "d8bf2cad-40d4-4e8f-99e1-12239d28c772", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/requestable-objects?identity-id=e7eab60924f64aa284175b9fa3309599&types=ACCESS_PROFILE,ACCESS_PROFILE&term=Finance Role&statuses=ASSIGNED,PENDING&limit=250&offset=0&count=true&filters=name sw \"bob\"&sorters=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "requestable-objects" - ], - "query": [ - { - "key": "identity-id", - "value": "e7eab60924f64aa284175b9fa3309599", - "description": "If present, the value returns only requestable objects for the specified identity.\n * Admin users can call this with any identity ID value.\n * Non-admin users can only specify *me* or pass their own identity ID value.\n * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result." - }, - { - "key": "types", - "value": "ACCESS_PROFILE,ACCESS_PROFILE", - "description": "Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice." - }, - { - "key": "term", - "value": "Finance Role", - "description": "It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored." - }, - { - "key": "statuses", - "value": "ASSIGNED,PENDING", - "description": "Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "name sw \"bob\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n" - }, - { - "key": "sorters", - "value": "name", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**\n" - } - ], - "variable": [ - { - "id": "d346975a-eb90-4623-9c88-af7fb5afa619", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.\nAny authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity." - }, - "response": [ - { - "id": "59d3a3be-1246-4a7c-b255-e99e422c99df", - "name": "List of requestable objects", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/requestable-objects?identity-id=e7eab60924f64aa284175b9fa3309599&types=ACCESS_PROFILE,ACCESS_PROFILE&term=Finance Role&statuses=ASSIGNED,PENDING&limit=250&offset=0&count=true&filters=name sw \"bob\"&sorters=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "requestable-objects" - ], - "query": [ - { - "key": "identity-id", - "value": "e7eab60924f64aa284175b9fa3309599" - }, - { - "key": "types", - "value": "ACCESS_PROFILE,ACCESS_PROFILE" - }, - { - "key": "term", - "value": "Finance Role" - }, - { - "key": "statuses", - "value": "ASSIGNED,PENDING" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name sw \"bob\"" - }, - { - "key": "sorters", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Applied Research Access\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Access to research information, lab results, and schematics.\",\n \"type\": \"ACCESS_PROFILE\",\n \"requestStatus\": \"AVAILABLE\",\n \"identityRequestId\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"requestCommentsRequired\": false\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Applied Research Access\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Access to research information, lab results, and schematics.\",\n \"type\": \"ACCESS_PROFILE\",\n \"requestStatus\": \"AVAILABLE\",\n \"identityRequestId\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"requestCommentsRequired\": false\n }\n]" - }, - { - "id": "d0f1da89-f389-4fe8-91e3-c1fe13a78116", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/requestable-objects?identity-id=e7eab60924f64aa284175b9fa3309599&types=ACCESS_PROFILE,ACCESS_PROFILE&term=Finance Role&statuses=ASSIGNED,PENDING&limit=250&offset=0&count=true&filters=name sw \"bob\"&sorters=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "requestable-objects" - ], - "query": [ - { - "key": "identity-id", - "value": "e7eab60924f64aa284175b9fa3309599" - }, - { - "key": "types", - "value": "ACCESS_PROFILE,ACCESS_PROFILE" - }, - { - "key": "term", - "value": "Finance Role" - }, - { - "key": "statuses", - "value": "ASSIGNED,PENDING" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name sw \"bob\"" - }, - { - "key": "sorters", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "4860281c-abf9-47bd-ac5c-df8c1706628b", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/requestable-objects?identity-id=e7eab60924f64aa284175b9fa3309599&types=ACCESS_PROFILE,ACCESS_PROFILE&term=Finance Role&statuses=ASSIGNED,PENDING&limit=250&offset=0&count=true&filters=name sw \"bob\"&sorters=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "requestable-objects" - ], - "query": [ - { - "key": "identity-id", - "value": "e7eab60924f64aa284175b9fa3309599" - }, - { - "key": "types", - "value": "ACCESS_PROFILE,ACCESS_PROFILE" - }, - { - "key": "term", - "value": "Finance Role" - }, - { - "key": "statuses", - "value": "ASSIGNED,PENDING" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name sw \"bob\"" - }, - { - "key": "sorters", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "78f709d4-2b3d-45fc-9dee-0c84dea0fd83", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/requestable-objects?identity-id=e7eab60924f64aa284175b9fa3309599&types=ACCESS_PROFILE,ACCESS_PROFILE&term=Finance Role&statuses=ASSIGNED,PENDING&limit=250&offset=0&count=true&filters=name sw \"bob\"&sorters=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "requestable-objects" - ], - "query": [ - { - "key": "identity-id", - "value": "e7eab60924f64aa284175b9fa3309599" - }, - { - "key": "types", - "value": "ACCESS_PROFILE,ACCESS_PROFILE" - }, - { - "key": "term", - "value": "Finance Role" - }, - { - "key": "statuses", - "value": "ASSIGNED,PENDING" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name sw \"bob\"" - }, - { - "key": "sorters", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "898499fb-2f0a-44a4-a3c3-51f4492eea82", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/requestable-objects?identity-id=e7eab60924f64aa284175b9fa3309599&types=ACCESS_PROFILE,ACCESS_PROFILE&term=Finance Role&statuses=ASSIGNED,PENDING&limit=250&offset=0&count=true&filters=name sw \"bob\"&sorters=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "requestable-objects" - ], - "query": [ - { - "key": "identity-id", - "value": "e7eab60924f64aa284175b9fa3309599" - }, - { - "key": "types", - "value": "ACCESS_PROFILE,ACCESS_PROFILE" - }, - { - "key": "term", - "value": "Finance Role" - }, - { - "key": "statuses", - "value": "ASSIGNED,PENDING" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name sw \"bob\"" - }, - { - "key": "sorters", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "f0806fdb-e41c-4d35-9e3e-88e4b568a50d", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/requestable-objects?identity-id=e7eab60924f64aa284175b9fa3309599&types=ACCESS_PROFILE,ACCESS_PROFILE&term=Finance Role&statuses=ASSIGNED,PENDING&limit=250&offset=0&count=true&filters=name sw \"bob\"&sorters=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "requestable-objects" - ], - "query": [ - { - "key": "identity-id", - "value": "e7eab60924f64aa284175b9fa3309599" - }, - { - "key": "types", - "value": "ACCESS_PROFILE,ACCESS_PROFILE" - }, - { - "key": "term", - "value": "Finance Role" - }, - { - "key": "statuses", - "value": "ASSIGNED,PENDING" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name sw \"bob\"" - }, - { - "key": "sorters", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "b6fa4e07-6151-4fc9-8ac7-1cf05bd44e10", - "description": "Use this API to implement requestable object functionality. \nWith this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/idn/api/v3/access-requests), along with their statuses. \nThis can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available.\n" - }, - { - "name": "Saved Search", - "item": [ - { - "name": "Create a saved search", - "id": "113c73a5-24e3-4e7e-a01a-ac3e9359b693", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"velit3f\": [\n {\n \"field\": \"Excepteur nostrud est non\",\n \"header\": \"in Lorem eiusmod commodo\"\n },\n {\n \"field\": \"pariatur qui minim\",\n \"header\": \"cu\"\n }\n ],\n \"ut5\": [\n {\n \"field\": \"irure eiusmod\",\n \"header\": \"Excepteur quis sed\"\n },\n {\n \"field\": \"officia aute consectetur ut velit\",\n \"header\": \"nisi cillum voluptate\"\n }\n ],\n \"velit_f2\": [\n {\n \"field\": \"sunt dolore veniam cupidatat\",\n \"header\": \"Duis esse sed\"\n },\n {\n \"field\": \"et\",\n \"header\": \"in non\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches" - ], - "variable": [ - { - "id": "0d541c14-c717-4bd1-8c4e-5561ba8dab1a", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Creates a new saved search.\n" - }, - "response": [ - { - "id": "409f1406-e3af-4341-bed5-9054c0e1e241", - "name": "The persisted saved search.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"est66\": [\n {\n \"field\": \"consequat enim exercitation Ut\",\n \"header\": \"eu\"\n },\n {\n \"field\": \"ullamco sed\",\n \"header\": \"Duis incididunt fugiat non cillum\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"mollit_a\": [\n {\n \"field\": \"pariatur et\",\n \"header\": \"aliq\"\n },\n {\n \"field\": \"fugiat dolor Lorem\",\n \"header\": \"laboris irure nostrud sed\"\n }\n ],\n \"amet_9b\": [\n {\n \"field\": \"ipsum culpa amet\",\n \"header\": \"deserunt ut culpa\"\n },\n {\n \"field\": \"qui voluptate dolor\",\n \"header\": \"exerci\"\n }\n ],\n \"id_b\": [\n {\n \"field\": \"tempor dolor\",\n \"header\": \"fugiat\"\n },\n {\n \"field\": \"elit enim\",\n \"header\": \"non Ut consequat d\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}" - }, - { - "id": "f12a5c37-7a38-4495-8fad-e120438d21ea", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"est66\": [\n {\n \"field\": \"consequat enim exercitation Ut\",\n \"header\": \"eu\"\n },\n {\n \"field\": \"ullamco sed\",\n \"header\": \"Duis incididunt fugiat non cillum\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "3357b158-e2ad-45fc-a314-96ac16ec1135", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"est66\": [\n {\n \"field\": \"consequat enim exercitation Ut\",\n \"header\": \"eu\"\n },\n {\n \"field\": \"ullamco sed\",\n \"header\": \"Duis incididunt fugiat non cillum\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Return a list of Saved Searches", - "id": "533bf577-8742-4981-9da7-a9910014f1df", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches?offset=0&limit=250&count=true&filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches" - ], - "query": [ - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).\n\nAllowed filter properties: *owner.id*, *public*\n\nAllowed filter operator: *eq*\n\n**Example filters**:\n\n```owner.id eq \"0de46054-fe90-434a-b84e-c6b3359d0c64\"``` -- returns saved searches for the specified owner ID\n\n```public eq true``` -- returns all public saved searches\n\n```owner.id eq me or public eq true``` -- returns all of the current user's saved searches as well as all public saved searches belonging to other users in the current org\n" - } - ], - "variable": [ - { - "id": "ff732218-e422-49a0-9a4f-6ae1eb5fa3a6", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Returns a list of saved searches.\n" - }, - "response": [ - { - "id": "e792582f-e0b5-458c-8f6b-51a8a99092a4", - "name": "The list of requested saved searches.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches?offset=0&limit=250&count=true&filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "disabled": false, - "description": "The total result count (returned only if the *count* parameter is specified as *true*).", - "key": "X-Total-Count", - "value": "69845467" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"veniam_b72\": [\n {\n \"field\": \"qui\",\n \"header\": \"ut ex\"\n },\n {\n \"field\": \"qui et\",\n \"header\": \"velit Lorem commodo nulla\"\n }\n ],\n \"magna_66a\": [\n {\n \"field\": \"irure dolore aute\",\n \"header\": \"cillum amet esse laborum ex\"\n },\n {\n \"field\": \"sunt a\",\n \"header\": \"sint m\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n },\n {\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"anim261\": [\n {\n \"field\": \"deserunt nisi proident eiusmod\",\n \"header\": \"reprehenderit esse adipisicing\"\n },\n {\n \"field\": \"incididunt do\",\n \"header\": \"ut eu voluptate\"\n }\n ],\n \"labore_b\": [\n {\n \"field\": \"sit non magna\",\n \"header\": \"ut labore est ullamco pariatur\"\n },\n {\n \"field\": \"in adipisicing Excepteur enim quis\",\n \"header\": \"do\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n }\n]" - }, - { - "id": "66ac5e61-5985-463b-b7ac-3883e6c1d12c", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches?offset=0&limit=250&count=true&filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "99116237-a3a0-4c81-95d9-a131a2b3b89a", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches?offset=0&limit=250&count=true&filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Updates an existing saved search\n", - "id": "ace62b20-aa36-41e7-bc69-f0b6e2e98bfb", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"mollit_a\": [\n {\n \"field\": \"pariatur et\",\n \"header\": \"aliq\"\n },\n {\n \"field\": \"fugiat dolor Lorem\",\n \"header\": \"laboris irure nostrud sed\"\n }\n ],\n \"amet_9b\": [\n {\n \"field\": \"ipsum culpa amet\",\n \"header\": \"deserunt ut culpa\"\n },\n {\n \"field\": \"qui voluptate dolor\",\n \"header\": \"exerci\"\n }\n ],\n \"id_b\": [\n {\n \"field\": \"tempor dolor\",\n \"header\": \"fugiat\"\n },\n {\n \"field\": \"elit enim\",\n \"header\": \"non Ut consequat d\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "id": "1c2f0909-8691-4ebe-ab6a-3e52621ad320", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "92a0bc72-1bce-497b-b26a-e38d26e19ed7", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Updates an existing saved search.\n" - }, - "response": [ - { - "id": "8734afe6-6beb-4d32-81e9-556265f0e1ae", - "name": "The persisted saved search.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"non91\": [\n {\n \"field\": \"Lorem officia\",\n \"header\": \"Excepteur cupidat\"\n },\n {\n \"field\": \"cillum Ut\",\n \"header\": \"Ut laboris\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"mollit_a\": [\n {\n \"field\": \"pariatur et\",\n \"header\": \"aliq\"\n },\n {\n \"field\": \"fugiat dolor Lorem\",\n \"header\": \"laboris irure nostrud sed\"\n }\n ],\n \"amet_9b\": [\n {\n \"field\": \"ipsum culpa amet\",\n \"header\": \"deserunt ut culpa\"\n },\n {\n \"field\": \"qui voluptate dolor\",\n \"header\": \"exerci\"\n }\n ],\n \"id_b\": [\n {\n \"field\": \"tempor dolor\",\n \"header\": \"fugiat\"\n },\n {\n \"field\": \"elit enim\",\n \"header\": \"non Ut consequat d\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}" - }, - { - "id": "c785eb63-5677-4c29-ab5c-18e96f3141f7", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"non91\": [\n {\n \"field\": \"Lorem officia\",\n \"header\": \"Excepteur cupidat\"\n },\n {\n \"field\": \"cillum Ut\",\n \"header\": \"Ut laboris\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "cd21c619-4c14-40b5-a468-d85e1839d6fa", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"non91\": [\n {\n \"field\": \"Lorem officia\",\n \"header\": \"Excepteur cupidat\"\n },\n {\n \"field\": \"cillum Ut\",\n \"header\": \"Ut laboris\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Return a saved search by ID", - "id": "ed19c499-8bfc-4477-95b9-43ac5ef67122", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "id": "10cc6765-c3e4-42e5-8ff4-62e75df8730a", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "d900e53c-aee0-4fec-bc16-a5b9b734b872", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Returns the specified saved search.\n" - }, - "response": [ - { - "id": "e436d9d0-5384-4139-87f6-09dc6fc946cd", - "name": "The requested saved search.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": \"@accounts(disabled:true)\",\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"public\": false,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"columns\": {\n \"mollit_a\": [\n {\n \"field\": \"pariatur et\",\n \"header\": \"aliq\"\n },\n {\n \"field\": \"fugiat dolor Lorem\",\n \"header\": \"laboris irure nostrud sed\"\n }\n ],\n \"amet_9b\": [\n {\n \"field\": \"ipsum culpa amet\",\n \"header\": \"deserunt ut culpa\"\n },\n {\n \"field\": \"qui voluptate dolor\",\n \"header\": \"exerci\"\n }\n ],\n \"id_b\": [\n {\n \"field\": \"tempor dolor\",\n \"header\": \"fugiat\"\n },\n {\n \"field\": \"elit enim\",\n \"header\": \"non Ut consequat d\"\n }\n ]\n },\n \"fields\": [\n \"disabled\"\n ],\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\n ]\n }\n }\n}" - }, - { - "id": "6115709c-1dec-47d1-bc0e-fc2400ae4e5c", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete a document by ID", - "id": "04fa4dce-8535-4396-9f05-8bc9ea0c3258", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "id": "63dfdf64-ce27-4d23-a07a-651aa1bf3f0a", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "136344c2-3da4-4796-9b4b-c19d9b152e25", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Deletes the specified saved search.\n" - }, - "response": [ - { - "id": "ea875519-af75-4194-b02f-154e8c307b3e", - "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "0384c9a9-1496-48b9-b19d-cbd9f695f5b8", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0f005541-7f6c-49b4-9b70-6ea9d8fab8e9", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "450ff801-6671-4810-bb66-1ef5e1381ff8", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/saved-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Execute a saved search by ID", - "id": "016188ac-3081-4468-b19b-130f19ddd4db", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"scheduleId\": \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id/execute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id", - "execute" - ], - "variable": [ - { - "id": "e35a1756-9f17-4200-bbd7-dd4def04e125", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "1c391501-7772-4b96-881c-bf75152d8926", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Executes the specified saved search.\n" - }, - "response": [ - { - "id": "5a72e011-ede5-4537-8b9b-944a01f5768e", - "name": "Accepted - Returned if the request was successfully accepted into the system.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"scheduleId\": \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id/execute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id", - "execute" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "d0fcc679-ed8c-4173-9ec6-8b759dac25b6", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"scheduleId\": \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id/execute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id", - "execute" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "35929d74-c806-4c4c-98e3-720cf2b8b0ce", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"scheduleId\": \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id/execute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id", - "execute" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "88178ad0-5aad-4428-b6ef-7ce8e0756cca", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"scheduleId\": \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id/execute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id", - "execute" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "e4e6e469-7fc4-401d-b3f6-61d39a505bfe", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"scheduleId\": \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id/execute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id", - "execute" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "dfb4626c-76c6-4950-9e10-f37d7529090b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"scheduleId\": \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id/execute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id", - "execute" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "f50533c1-b227-4bf1-b8e6-0faefd0701d1", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"scheduleId\": \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/saved-searches/:id/execute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "saved-searches", - ":id", - "execute" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "c088a774-fc4c-4ecc-a0cd-d3a278872d56" - }, - { - "name": "Scheduled Search", - "item": [ - { - "name": "Create a new scheduled search", - "id": "2a0a3c7d-a163-452b-bab8-21835f6e5662", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches" - ], - "variable": [ - { - "id": "1bbb17c0-6d2d-4701-99fb-4ca730ed6fce", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Creates a new scheduled search.\n" - }, - "response": [ - { - "id": "4de48a2f-526e-410f-8763-1ba3ecff4a5b", - "name": "The persisted scheduled search.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n}" - }, - { - "id": "2cbaf303-9a0b-4f96-8532-0f2e9261b1c1", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "d25952e4-d5c5-4aa7-8b56-b35dda75c0dc", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Return a list of scheduled searches", - "id": "128975aa-dccb-4b74-a1d2-77a65a26a257", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches?offset=0&limit=250&count=true&filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches" - ], - "query": [ - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "eu", - "description": "An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).\n\nAllowed filter properties: *owner.id*, *savedSearchId*\n\nAllowed filter operator: *eq*\n\n**Example filters**:\n\n```owner.id eq \"0de46054-fe90-434a-b84e-c6b3359d0c64\"``` -- returns scheduled searches for the specified owner ID\n\n```savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"``` -- returns scheduled searches that reference the specified saved search\n\n```owner.id eq me or savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"``` -- returns all of the current user's scheduled searches as well as all scheduled searches that reference the specified saved search\n" - } - ], - "variable": [ - { - "id": "3231824c-ff44-41d4-9691-1c12ea72d156", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Returns a list of scheduled searches.\n" - }, - "response": [ - { - "id": "eae345c7-c595-4b37-8f0a-1ebed8c5a5f3", - "name": "The list of requested scheduled searches.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches?offset=0&limit=250&count=true&filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "disabled": false, - "description": "The total result count (returned only if the *count* parameter is specified as *true*).", - "key": "X-Total-Count", - "value": "69845467" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n },\n {\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n }\n]" - }, - { - "id": "f9ef7dba-b379-4a39-9400-dbb0cbd7a646", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches?offset=0&limit=250&count=true&filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "76793d18-eb2c-4b76-b950-eab82f907993", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches?offset=0&limit=250&count=true&filters=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update an existing Scheduled Search", - "id": "f49cd95e-3410-424e-8029-3c7c601d1008", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "id": "b3c28a26-0278-4d9f-b574-684c61f0762e", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "dd27e5a0-6196-46b9-912a-75ad5e89ff83", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Updates an existing scheduled search.\n" - }, - "response": [ - { - "id": "d36b17c7-15b4-4052-aeb4-d4bf2534121e", - "name": "The persisted scheduled search.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n}" - }, - { - "id": "100ff69d-55a9-4ab5-a621-47bd3e281671", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "7dffc46a-7eba-4598-aa37-1e54cabc82d5", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "11768827-89b6-419a-82e0-21ccebb5f6a9", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Return a Scheduled Search by ID", - "id": "ecdb0b97-e47a-47e1-9183-d3ad3af3d987", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "id": "96260801-8946-46c0-a6eb-73008d18457c", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "c6620059-3c6c-4dab-89eb-5df48beb8511", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Returns the specified scheduled search.\n" - }, - "response": [ - { - "id": "f011a49a-879f-4e39-ae35-ec23919ece32", - "name": "The requested scheduled search.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"GMT-06:00\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n }\n ],\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false,\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c9180867624cbd7017642d8c8c81f67\"\n}" - }, - { - "id": "b16f8442-39f3-46aa-9f7c-8cdd2004c8dc", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete a Scheduled Search by ID", - "id": "f5d3e180-9a46-4da9-bc7b-3d0be6c6c981", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "id": "8940e86a-e486-4b11-807c-cce75feb5d9b", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "659bc602-aab0-49f9-955b-b58969a1f22a", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Deletes the specified scheduled search.\n" - }, - "response": [ - { - "id": "70858afc-e697-4cf5-a27e-1cd1c0edd7f3", - "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "08751091-e40f-4966-98be-0fdd8479bd03", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "9239a110-1782-40f1-82ac-e66f24079e75", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Unsubscribe a recipient from Scheduled Search", - "id": "d3a80100-880a-45ee-b8c6-3ae80509bff2", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id/unsubscribe", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id", - "unsubscribe" - ], - "variable": [ - { - "id": "f982ec75-2e01-47c2-93e5-e7741807934d", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "66c9b3c0-5ecf-4e17-bfe2-945fa996ae29", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Unsubscribes a recipient from the specified scheduled search.\n" - }, - "response": [ - { - "id": "76b140f7-2e1f-4577-b8ab-3b5aa8197a40", - "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id/unsubscribe", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id", - "unsubscribe" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "46bd8d71-5e60-435b-bc84-62eaa0056de7", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id/unsubscribe", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id", - "unsubscribe" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "897228a4-6b7b-4f01-b5ec-8c57cf612a4f", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id/unsubscribe", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id", - "unsubscribe" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "71e90f74-d435-48a5-941c-33cdd440201f", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduled-searches/:id/unsubscribe", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduled-searches", - ":id", - "unsubscribe" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - } - ] - } - ], - "id": "358ad934-da48-49f5-a6ff-91c7063d1677" - }, - { - "name": "Search", - "item": [ - { - "name": "Perform Search", - "id": "f686c1cd-279f-434a-a942-180306738f92", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"\\\"John Doe\\\"\",\n \"fields\": [\n \"name\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search" - ], - "query": [ - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - } - ], - "variable": [ - { - "id": "c580332c-7d2d-4424-9c91-dc25950f991d", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Performs a search with the provided query and returns a matching result collection." - }, - "response": [ - { - "id": "4987c58b-6474-4dcb-ae0b-a8bf8682bb4f", - "name": "List of matching documents.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"\\\"John Doe\\\"\",\n \"fields\": [\n \"name\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "disabled": false, - "description": "The total result count (returned only if the *count* parameter is specified as *true*).", - "key": "X-Total-Count", - "value": "69845467" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180825a6c1adc015a71c9023f0818\",\n \"name\": \"Cloud Eng\",\n \"_type\": \"accessprofile\",\n \"description\": \"Cloud Eng\",\n \"created\": \"2017-02-24T20:21:23.145Z\",\n \"modified\": \"2019-05-24T20:36:04.312Z\",\n \"synced\": \"2020-02-18T05:30:20.414Z\",\n \"enabled\": true,\n \"requestable\": true,\n \"requestCommentsRequired\": false,\n \"owner\": {\n \"id\": \"ff8081815757d36a015757d42e56031e\",\n \"name\": \"SailPoint Support\",\n \"type\": \"IDENTITY\",\n \"email\": \"cloud-support@sailpoint.com\"\n },\n \"source\": {\n \"id\": \"ff8081815757d4fb0157588f3d9d008f\",\n \"name\": \"Employees\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918084575812550157589064f33b89\",\n \"name\": \"CN=Cloud Engineering,DC=sailpoint,DC=COM\",\n \"description\": \"mull\",\n \"attribute\": \"memberOf\",\n \"value\": \"CN=Cloud Engineering,DC=sailpoint,DC=COM\"\n }\n ],\n \"entitlementCount\": 1,\n \"tags\": [\n \"TAG_1\",\n \"TAG_2\"\n ]\n }\n]" - }, - { - "id": "57f15d76-59c8-4d61-b68c-778cf66b8f61", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"\\\"John Doe\\\"\",\n \"fields\": [\n \"name\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "ceea31b5-802c-4896-a038-515e3cca30fd", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"\\\"John Doe\\\"\",\n \"fields\": [\n \"name\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "8e10aeea-9135-4613-8f9f-016347ff6b25", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"\\\"John Doe\\\"\",\n \"fields\": [\n \"name\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "be4f08a6-b158-498d-8acf-9bc054c5ac0b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"\\\"John Doe\\\"\",\n \"fields\": [\n \"name\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "2c28ad70-ada9-4c08-b8df-fd453e3b6f87", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"\\\"John Doe\\\"\",\n \"fields\": [\n \"name\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Count the number of Documents satisfying a Query", - "id": "e63fd56e-20ba-44c5-9883-cb0f27dd0018", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"created: [2022-05-19T19:26:03.351Z TO now]\",\n \"timeZone\": \"America/Los_Angeles\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search/count", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - "count" - ], - "variable": [ - { - "id": "de5c2677-b100-462b-be3f-f0919d790fad", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Performs a search with provided query and returns count of results in the X-Total-Count header." - }, - "response": [ - { - "id": "8bf3a9d5-8922-4ab6-bc28-d03ca54aee16", - "name": "No content - indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"created: [2022-05-19T19:26:03.351Z TO now]\",\n \"timeZone\": \"America/Los_Angeles\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search/count", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - "count" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "disabled": false, - "description": "The total result count.", - "key": "X-Total-Count", - "value": "69845467" - }, - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "6e08b849-4963-496a-8611-4b5844a8f979", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"created: [2022-05-19T19:26:03.351Z TO now]\",\n \"timeZone\": \"America/Los_Angeles\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search/count", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - "count" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e1e32c83-5f4b-4142-b26b-3c90b2e2b54d", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"identities\"\n ],\n \"query\": {\n \"query\": \"created: [2022-05-19T19:26:03.351Z TO now]\",\n \"timeZone\": \"America/Los_Angeles\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search/count", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - "count" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Perform a Search Query Aggregation", - "id": "0e1ecb19-2278-4610-9966-de9964cea785", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"aggregations\"\n ],\n \"aggregationType\": \"SAILPOINT\",\n \"aggregations\": {\n \"metric\": {\n \"name\": \"How Many Locations\",\n \"type\": \"UNIQUE_COUNT\",\n \"field\": \"attributes.city\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search/aggregate?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - "aggregate" - ], - "query": [ - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - } - ], - "variable": [ - { - "id": "c3092aea-f70b-4e78-81c4-62b5c6ba1bbb", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Performs a search query aggregation and returns aggregation result." - }, - "response": [ - { - "id": "839e3e4a-9316-40b1-a87a-d75db92acb8a", - "name": "Aggregation results.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"aggregations\"\n ],\n \"aggregationType\": \"SAILPOINT\",\n \"aggregations\": {\n \"metric\": {\n \"name\": \"How Many Locations\",\n \"type\": \"UNIQUE_COUNT\",\n \"field\": \"attributes.city\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search/aggregate?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - "aggregate" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "disabled": false, - "description": "The total result count (returned only if the *count* parameter is specified as *true*).", - "key": "X-Total-Count", - "value": "69845467" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"aggregations\": {\n \"Identity Locations\": {\n \"buckets\": [\n {\n \"key\": \"Austin\",\n \"doc_count\": 109\n },\n {\n \"key\": \"London\",\n \"doc_count\": 64\n },\n {\n \"key\": \"San Jose\",\n \"doc_count\": 27\n },\n {\n \"key\": \"Brussels\",\n \"doc_count\": 26\n },\n {\n \"key\": \"Sao Paulo\",\n \"doc_count\": 24\n },\n {\n \"key\": \"Munich\",\n \"doc_count\": 23\n },\n {\n \"key\": \"Singapore\",\n \"doc_count\": 22\n },\n {\n \"key\": \"Tokyo\",\n \"doc_count\": 20\n },\n {\n \"key\": \"Taipei\",\n \"doc_count\": 16\n }\n ]\n }\n },\n \"hits\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"_type\": \"event\",\n \"description\": \"Ut exercitation nostrud\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"synced\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": true,\n \"requestable\": true,\n \"requestCommentsRequired\": true,\n \"owner\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"type\": \"IDENTITY\",\n \"email\": \"sed dolor non\"\n },\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"description\": \"in id\",\n \"attribute\": \"eiusmod aute magna tempor pariatur\",\n \"value\": \"d\"\n },\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"description\": \"non esse adipisicing\",\n \"attribute\": \"Excepteur dolore exercitation\",\n \"value\": \"pariatur incididunt\"\n }\n ],\n \"entitlementCount\": -76630522,\n \"tags\": [\n \"TAG_1\",\n \"TAG_2\"\n ]\n },\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"_type\": \"accessprofile\",\n \"description\": \"ea cillum ullamco\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"synced\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": false,\n \"requestable\": true,\n \"requestCommentsRequired\": true,\n \"owner\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"type\": \"IDENTITY\",\n \"email\": \"ea ex cupidatat est\"\n },\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"description\": \"dolor proident laboris in\",\n \"attribute\": \"ut ea\",\n \"value\": \"exercitation\"\n },\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"description\": \"id aliquip elit sit\",\n \"attribute\": \"consectetur tempor dolor enim labore\",\n \"value\": \"dolore in\"\n }\n ],\n \"entitlementCount\": 51158426,\n \"tags\": [\n \"TAG_1\",\n \"TAG_2\"\n ]\n }\n ]\n}" - }, - { - "id": "4300e5d7-7937-4563-b01b-96635489be6f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"aggregations\"\n ],\n \"aggregationType\": \"SAILPOINT\",\n \"aggregations\": {\n \"metric\": {\n \"name\": \"How Many Locations\",\n \"type\": \"UNIQUE_COUNT\",\n \"field\": \"attributes.city\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search/aggregate?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - "aggregate" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "80d09314-4cbd-4e52-a3da-effbfadca48b", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"indices\": [\n \"aggregations\"\n ],\n \"aggregationType\": \"SAILPOINT\",\n \"aggregations\": {\n \"metric\": {\n \"name\": \"How Many Locations\",\n \"type\": \"UNIQUE_COUNT\",\n \"field\": \"attributes.city\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/search/aggregate?offset=0&limit=250&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - "aggregate" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get a Document by ID", - "id": "c7d6f788-d5e8-46ed-875f-78069e6dd234", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/search/:index/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - ":index", - ":id" - ], - "variable": [ - { - "id": "23d6767e-b971-4df9-af71-02aa3deb9c74", - "key": "index", - "value": "eu", - "description": "(Required) The index from which to fetch the specified document.\n\nThe currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*.\n" - }, - { - "id": "7b0991d4-5a39-4b59-8883-f2254dcfa5a8", - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "id": "c7d970a1-6608-4e9e-ae64-4aab1e958d04", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Fetches a single document from the specified index using the specified document ID." - }, - "response": [ - { - "id": "fcf2b16b-9bfe-497a-b549-705db443c044", - "name": "The requested document.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/search/:index/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - ":index", - ":id" - ], - "variable": [ - { - "key": "index", - "value": "eu", - "description": "(Required) The index from which to fetch the specified document.\n\nThe currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*.\n" - }, - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180825a6c1adc015a71c9023f0818\",\n \"name\": \"Cloud Eng\",\n \"_type\": \"accessprofile\",\n \"description\": \"Cloud Eng\",\n \"created\": \"2017-02-24T20:21:23.145Z\",\n \"modified\": \"2019-05-24T20:36:04.312Z\",\n \"synced\": \"2020-02-18T05:30:20.414Z\",\n \"enabled\": true,\n \"requestable\": true,\n \"requestCommentsRequired\": false,\n \"owner\": {\n \"id\": \"ff8081815757d36a015757d42e56031e\",\n \"name\": \"SailPoint Support\",\n \"type\": \"IDENTITY\",\n \"email\": \"cloud-support@sailpoint.com\"\n },\n \"source\": {\n \"id\": \"ff8081815757d4fb0157588f3d9d008f\",\n \"name\": \"Employees\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918084575812550157589064f33b89\",\n \"name\": \"CN=Cloud Engineering,DC=sailpoint,DC=COM\",\n \"description\": \"mull\",\n \"attribute\": \"memberOf\",\n \"value\": \"CN=Cloud Engineering,DC=sailpoint,DC=COM\"\n }\n ],\n \"entitlementCount\": 1,\n \"tags\": [\n \"TAG_1\",\n \"TAG_2\"\n ]\n}" - }, - { - "id": "9ca9070f-4245-4e02-9029-b1928a57de3e", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/search/:index/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - ":index", - ":id" - ], - "variable": [ - { - "key": "index", - "value": "eu", - "description": "(Required) The index from which to fetch the specified document.\n\nThe currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*.\n" - }, - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "99246f16-1d76-402a-b111-257150c1cb86", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/search/:index/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "search", - ":index", - ":id" - ], - "variable": [ - { - "key": "index", - "value": "eu", - "description": "(Required) The index from which to fetch the specified document.\n\nThe currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*.\n" - }, - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the requested document." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - } - ] - } - ], - "id": "c4807777-e2f7-461c-bdb2-69adb7488e2d" - }, - { - "name": "Service Desk Integration", - "item": [ - { - "name": "List existing Service Desk Integrations", - "id": "4ad52ba4-56a8-4552-a891-aa928885ee4d", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations?offset=0&limit=250&sorters=eu&filters=eu&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "query": [ - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "sorters", - "value": "eu", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**" - }, - { - "key": "filters", - "value": "eu", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq*\n\n**type**: *eq, in*\n\n**cluster**: *eq, in*" - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - } - ], - "variable": [ - { - "id": "dc85ab2c-5e57-4cea-90f9-55ccbbb5d2e1", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "22c150dc-a9eb-4c25-88d4-3011a7a00d5a", - "name": "List of ServiceDeskIntegrationDto", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations?offset=0&limit=250&sorters=eu&filters=eu&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"attributes\": {\n \"laboruma\": 29048227.476239756\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"id12345\",\n \"created\": \"1995-11-29T13:28:36.388Z\",\n \"modified\": \"1958-11-12T23:47:21.071Z\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"proident enim Excepteur incididunt\",\n \"ad esse\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"esse fugiat\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n },\n {\n \"attributes\": {\n \"eu_5b2\": -25406911.87373589,\n \"laborum_7\": \"incididunt consequat ut\"\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"id12345\",\n \"created\": \"2002-07-07T14:55:36.523Z\",\n \"modified\": \"2000-03-22T15:47:54.130Z\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"dolor exercitation magna labore\",\n \"amet Lorem ad in nostrud\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"ullamco\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n }\n]" - }, - { - "id": "143dff05-a2a4-4daf-b8eb-66d2ce29e29a", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations?offset=0&limit=250&sorters=eu&filters=eu&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "42fe3429-37d8-4d26-a59d-9ada08447f51", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations?offset=0&limit=250&sorters=eu&filters=eu&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "6e1f1136-64ba-40b5-a201-a8eed834722a", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations?offset=0&limit=250&sorters=eu&filters=eu&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "7b0f5bbc-3ed0-45e2-9887-a01e8f388077", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations?offset=0&limit=250&sorters=eu&filters=eu&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "9bab344f-3411-4e67-83d5-14669cf6eef7", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations?offset=0&limit=250&sorters=eu&filters=eu&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "37d79111-fb5e-499a-97ee-dc7812013928", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations?offset=0&limit=250&sorters=eu&filters=eu&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "sorters", - "value": "eu" - }, - { - "key": "filters", - "value": "eu" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create a new Service Desk integration", - "id": "0fe738fd-fd43-4783-afea-95733e143e5a", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"minimf8\": true,\n \"culpa_1\": 40053505.47558209\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"ea\",\n \"ad ipsum sunt anim\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"eiusmod ipsum qui\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "variable": [ - { - "id": "4eede053-0ca3-439f-b453-9e0c68e3e316", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "c9500fd0-eadd-4824-8e8d-7a3a48f1459d", - "name": "details of the created integration", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"attributes\": {\n \"eiusmod1\": \"ut eiusmod\",\n \"cupidatat083\": -7466625\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"id12345\",\n \"created\": \"1996-07-03T12:54:23.589Z\",\n \"modified\": \"1948-02-07T20:30:38.822Z\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"cillum\",\n \"sit Lorem ea\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"eiusmod officia\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}" - }, - { - "id": "36afebd4-833e-43d2-aff4-52a107c15173", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "62c1bcaa-84f6-40d0-9b6c-9d29d86e5eb8", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "93718144-de86-4556-8e4e-68dd3e3ba832", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "389c5799-1a25-4aca-aacc-6627270098c4", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "c7af8af5-ae75-4a6f-ae0c-c0e426180bb6", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "98f4ca9e-579c-484c-9c17-2426dff98685", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get a Service Desk integration by ID", - "id": "02d80508-e4c2-4c52-b570-39932d44e566", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "id": "e636cade-2de7-4446-b866-016a8bc5fa08", - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to get" - }, - { - "id": "8026ccb6-35af-4483-93fd-70c7fb72443c", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "16c61b28-497d-4759-b5b5-18d43ab1cf17", - "name": "ServiceDeskIntegrationDto with the given ID", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"attributes\": {\n \"eiusmod1\": \"ut eiusmod\",\n \"cupidatat083\": -7466625\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"id12345\",\n \"created\": \"1996-07-03T12:54:23.589Z\",\n \"modified\": \"1948-02-07T20:30:38.822Z\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"cillum\",\n \"sit Lorem ea\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"eiusmod officia\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}" - }, - { - "id": "493b7abc-f3f1-4ebf-828e-460ff5b49a05", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "57b5aafe-725f-43f4-bb14-0d0ca7689f7f", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "84f5f0b4-fdfb-4957-977a-86affdcb34d2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "98f9c827-2784-4a0c-9cea-8804b3ece548", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "fdebb425-7d82-4beb-86a3-e0ec88b5f60c", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "a6a6d5c3-9858-4eac-a975-8b8db589bb0a", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update a Service Desk integration by ID", - "id": "c2bb70a2-88b5-4daf-944e-75ae8e067b9c", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"minimf8\": true,\n \"culpa_1\": 40053505.47558209\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"ea\",\n \"ad ipsum sunt anim\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"eiusmod ipsum qui\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "id": "fa3140dd-35ea-42c0-83c1-d6fdbc2a973e", - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "id": "cd774227-bab9-422c-aa94-5d7ef693ac59", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "8d8a21e0-9d58-405e-bfcc-dd786a210111", - "name": "ServiceDeskIntegrationDto as updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"attributes\": {\n \"eiusmod1\": \"ut eiusmod\",\n \"cupidatat083\": -7466625\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"id12345\",\n \"created\": \"1996-07-03T12:54:23.589Z\",\n \"modified\": \"1948-02-07T20:30:38.822Z\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"cillum\",\n \"sit Lorem ea\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"eiusmod officia\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}" - }, - { - "id": "10a88500-e25a-49cc-b6e2-c307683dd5f3", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "efdef30f-85c9-4d12-908e-18b242074e32", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "aab5d679-ad9f-4f3b-a8b5-a6c2a75e8382", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "c8991041-652e-466f-ac5e-b183009ba1c1", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "d7f7b84c-1c9f-402e-8d7f-6ab960a89abe", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "b2dd3117-2776-47b2-a746-b2b2a76481aa", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"attributes\": {\n \"quis42\": false\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"consectetur ipsum ut\",\n \"proident Lorem in mollit\"\n ],\n \"provisioningConfig\": {\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"culpa dolore Ut nulla veniam\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete a Service Desk integration by ID", - "id": "a17d59a8-601b-4838-befb-db3746638442", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "id": "3e773b11-44fd-46b2-9b76-d57ba91f6e07", - "key": "id", - "value": "anId", - "description": "(Required) ID of Service Desk integration to delete" - }, - { - "id": "3e8b7d96-22f3-4dd7-aa9d-cd631724d1b1", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "21155559-fcc9-4f03-848b-6d4650dd4791", - "name": "Service Desk integration with the given ID successfully deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of Service Desk integration to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "9f75b96f-6afa-4ab0-9f5e-433d7e7bce19", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of Service Desk integration to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "035e8c4d-2dee-474d-acdc-85c18b296d36", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of Service Desk integration to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "edaa9201-2c3f-4cd5-ae6b-d9d1a81bab64", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of Service Desk integration to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "7f7ca1cf-c60f-49f6-8a90-5fc53804e182", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of Service Desk integration to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "8f34108a-9098-4c6f-970d-00e97b60a907", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of Service Desk integration to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "64810d8c-c1e7-477f-a870-5ce8826cadca", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of Service Desk integration to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Service Desk Integration Update - PATCH", - "id": "f75f3bb2-c0ba-48b2-b6a5-fdaf1c86f0df", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "id": "6436676d-34f8-4fab-94d8-159e549c703f", - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "id": "08f7c4f6-1d1b-44e4-a311-eaf57e5265b1", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Update an existing ServiceDeskIntegration by ID with a PATCH request." - }, - "response": [ - { - "id": "f1c126f4-918a-49d4-8ef8-04a1848187a2", - "name": "ServiceDeskIntegrationDto as updated", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"attributes\": {\n \"eiusmod1\": \"ut eiusmod\",\n \"cupidatat083\": -7466625\n },\n \"description\": \"A very nice Service Desk integration\",\n \"name\": \"aName\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"id12345\",\n \"created\": \"1996-07-03T12:54:23.589Z\",\n \"modified\": \"1948-02-07T20:30:38.822Z\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\"\n },\n \"cluster\": \"xyzzy999\",\n \"managedSources\": [\n \"cillum\",\n \"sit Lorem ea\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"eiusmod officia\"\n }\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\"\n }\n}" - }, - { - "id": "04fadbf7-e7dc-4be2-8dc3-e4892c9e0bf3", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "bc35cadd-c1c8-45e8-8fbf-b42ebbc9b3a3", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "5e284899-76e1-4d76-973e-781552a717a0", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "00c6ca8b-33c4-4b04-9f25-b856f52e113b", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "ee6badc5-6663-42c3-b2ca-027dfd940aca", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "e21125fb-5bfb-4be8-8c73-9d216640fbc0", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "anId", - "description": "(Required) ID of the Service Desk integration to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Service Desk Integration Types List.", - "id": "acfddc74-0baf-4af5-87ff-49fa0190608e", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "types" - ], - "variable": [ - { - "id": "a0ad7894-593f-4e34-866f-29e45f1aed3e", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "7ff45fa2-669b-4397-b87b-b7ace54b647c", - "name": "Responds with an array of the currently supported Service Desk integration types.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "types" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"type\": \"aType\",\n \"scriptName\": \"aScriptName\",\n \"name\": \"aName\"\n },\n {\n \"type\": \"aType\",\n \"scriptName\": \"aScriptName\",\n \"name\": \"aName\"\n }\n]" - }, - { - "id": "e3aeb659-b29a-4506-8bcb-ed778c84abc3", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "types" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "510fc8d8-61f5-4bbe-b7ec-b79f44dffb3d", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "types" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "7f3fe10a-d81f-4b83-bbaf-89fe6636ad9d", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "types" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "889b3de9-6174-410c-976d-be8e18634408", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "types" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "0d81996e-bf5e-4b2a-b43c-939d5eb85df0", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "types" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "2c552a33-ae56-4501-b5c6-98fd0ece93ad", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "types" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Service Desk integration template by scriptName.", - "id": "23ee8c13-25c3-4f2b-acd9-25c284d4e3e4", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/templates/:scriptName", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "templates", - ":scriptName" - ], - "variable": [ - { - "id": "b5ef0d9c-7fb0-40e9-bc02-8c4468905933", - "key": "scriptName", - "value": "aScriptName", - "description": "(Required) The scriptName value of the Service Desk integration template to get" - }, - { - "id": "e7b46036-f0f7-46ae-a76d-2e2fe828a3a9", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "fe4f9684-d0cc-4310-b92a-9c0c59e4ac67", - "name": "Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/templates/:scriptName", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "templates", - ":scriptName" - ], - "variable": [ - { - "key": "scriptName", - "value": "aScriptName", - "description": "(Required) The scriptName value of the Service Desk integration template to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"attributes\": {\n \"cupidatatb\": 78604154,\n \"qui_3\": \"ad et veniam\",\n \"nullaab\": -47228559.10941348,\n \"reprehenderit1d\": 810717\n },\n \"name\": \"aName\",\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\"\n },\n {\n \"type\": \"SOURCE\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"est\"\n }\n },\n \"type\": \"Web Service SDIM\",\n \"id\": \"id12345\",\n \"created\": \"2014-01-31T09:34:41.234Z\",\n \"modified\": \"2019-02-07T13:38:34.840Z\"\n}" - }, - { - "id": "82da5edc-5446-4d75-abcf-f55721b831d5", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/templates/:scriptName", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "templates", - ":scriptName" - ], - "variable": [ - { - "key": "scriptName", - "value": "aScriptName", - "description": "(Required) The scriptName value of the Service Desk integration template to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "79f7abfc-42ae-477d-922c-b49222532abf", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/templates/:scriptName", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "templates", - ":scriptName" - ], - "variable": [ - { - "key": "scriptName", - "value": "aScriptName", - "description": "(Required) The scriptName value of the Service Desk integration template to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "11161d26-d87a-4ca8-be24-d447477afe56", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/templates/:scriptName", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "templates", - ":scriptName" - ], - "variable": [ - { - "key": "scriptName", - "value": "aScriptName", - "description": "(Required) The scriptName value of the Service Desk integration template to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "4e719986-bffc-4e6e-861c-e1b5a58b4f5f", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/templates/:scriptName", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "templates", - ":scriptName" - ], - "variable": [ - { - "key": "scriptName", - "value": "aScriptName", - "description": "(Required) The scriptName value of the Service Desk integration template to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "b6797b58-3338-4543-92ca-065ea5886880", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/templates/:scriptName", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "templates", - ":scriptName" - ], - "variable": [ - { - "key": "scriptName", - "value": "aScriptName", - "description": "(Required) The scriptName value of the Service Desk integration template to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "26be0b46-6823-4a34-95dd-10c47b6616c3", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/templates/:scriptName", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "templates", - ":scriptName" - ], - "variable": [ - { - "key": "scriptName", - "value": "aScriptName", - "description": "(Required) The scriptName value of the Service Desk integration template to get" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get the time check configuration of queued SDIM tickets", - "id": "c525c4b7-976b-4e36-b9ab-9ce79bc8fe20", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "id": "db5e0036-7945-499f-b24d-847d241ec085", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "590212d2-496b-4a1f-b9e7-5bec55da543a", - "name": "QueuedCheckConfigDetails containing the configured values", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}" - }, - { - "id": "c2c681e1-f5bc-450c-be23-97d0ee057916", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "ecc5d6cd-169e-4b54-b409-ad520d4a6dc9", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "c790a094-9855-4722-9758-ec0621eb92cc", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "6ae0ded6-5cc2-4edb-acb9-e607d2584d31", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "1d1b66e9-b239-4a5e-bb24-5414b6fac69b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "a05214ec-38ac-4511-9e1e-ee9003de14e1", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update the time check configuration of queued SDIM tickets", - "id": "61aff581-5b66-4c13-a425-44f28742c3bf", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "id": "f0b441e7-b9ac-433d-9546-8384aa22bd95", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint." - }, - "response": [ - { - "id": "6d239fe8-1a27-4af3-bcf0-4b4affd28806", - "name": "QueuedCheckConfigDetails as updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}" - }, - { - "id": "a399345c-c75b-47c9-9c5b-81f3a3745b54", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "6c444609-38ef-49e5-afac-181446e8c077", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "0a6497dc-cbb5-4969-a548-ade097432141", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b16abb91-90ac-436f-8132-22e721d1dddb", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "1f704e66-faa2-4d72-9eb0-82ea08a58b77", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "868327b6-055a-4d7e-9bf1-922fb60f1024", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"exerc\",\n \"provisioningMaxStatusCheckDays\": \"tempor \"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/service-desk-integrations/status-check-configuration", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "service-desk-integrations", - "status-check-configuration" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "b99e1730-076f-4a31-ab84-7777e34b4c74", - "description": "Use this API to build an integration between IdentityNow and a service desk ITSM (IT service management) solution. \nOnce an administrator builds this integration between IdentityNow and a service desk, users can use IdentityNow to raise and track tickets that are synchronized between IdentityNow and the service desk. \n\nIn IdentityNow, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.'\n\nTo create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. \nSee [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in IdentityNow.\n\nAdministrators can create various service desk integrations, all with their own nuances. \nThe following service desk integrations are available: \n\n- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud/introduction.html)\n\n- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server/introduction.html)\n\n- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html)\n\n- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html)\n\n- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html)\n\n- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html)\n\n- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) \n" - }, - { - "name": "Sources", - "item": [ - { - "name": "Lists all sources in IdentityNow.", - "id": "113c52e2-e89d-4819-a9fb-07a570b4f815", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources?limit=50&offset=0&count=true&filters=name eq \"%23Employees\"&sorters=name&for-subadmin=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "limit", - "value": "50", - "description": "Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "filters", - "value": "name eq \"#Employees\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *co, eq, in, sw*\n\n**type**: *eq, in*\n\n**owner.id**: *eq, in*\n\n**features**: *ca, co*\n\n**created**: *eq*\n\n**modified**: *eq*\n\n**managementWorkgroup.id**: *eq*\n\n**description**: *eq*\n\n**authoritative**: *eq*\n\n**healthy**: *eq*\n\n**status**: *eq, in*\n\n**connectionType**: *eq*\n\n**connectorName**: *eq*" - }, - { - "key": "sorters", - "value": "name", - "description": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status**" - }, - { - "key": "for-subadmin", - "value": "name", - "description": "Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user.\nSubadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned." - } - ], - "variable": [ - { - "id": "4620d39d-9bf6-4277-8865-b08437d3f5bf", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point lists all the sources in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API." - }, - "response": [ - { - "id": "f969aed8-ae11-4799-922d-6df839d227f5", - "name": "List of Source objects", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources?limit=50&offset=0&count=true&filters=name eq \"%23Employees\"&sorters=name&for-subadmin=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "limit", - "value": "50" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name eq \"#Employees\"" - }, - { - "key": "sorters", - "value": "name" - }, - { - "key": "for-subadmin", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n },\n {\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n }\n]" - }, - { - "id": "c49cb4ed-79c8-458a-9339-522f1a94629a", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources?limit=50&offset=0&count=true&filters=name eq \"%23Employees\"&sorters=name&for-subadmin=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "limit", - "value": "50" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name eq \"#Employees\"" - }, - { - "key": "sorters", - "value": "name" - }, - { - "key": "for-subadmin", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "96e219ac-d606-4702-acb4-a2c486302c96", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources?limit=50&offset=0&count=true&filters=name eq \"%23Employees\"&sorters=name&for-subadmin=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "limit", - "value": "50" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name eq \"#Employees\"" - }, - { - "key": "sorters", - "value": "name" - }, - { - "key": "for-subadmin", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "a3ff3b74-8bb5-4a76-aae5-f69c7fed6bd2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources?limit=50&offset=0&count=true&filters=name eq \"%23Employees\"&sorters=name&for-subadmin=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "limit", - "value": "50" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name eq \"#Employees\"" - }, - { - "key": "sorters", - "value": "name" - }, - { - "key": "for-subadmin", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "7707a883-d7a6-4804-864e-4b589afd26f0", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources?limit=50&offset=0&count=true&filters=name eq \"%23Employees\"&sorters=name&for-subadmin=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "limit", - "value": "50" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name eq \"#Employees\"" - }, - { - "key": "sorters", - "value": "name" - }, - { - "key": "for-subadmin", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "1b4e1f98-71bf-4cf8-baf0-1ab108f94e7f", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources?limit=50&offset=0&count=true&filters=name eq \"%23Employees\"&sorters=name&for-subadmin=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "limit", - "value": "50" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name eq \"#Employees\"" - }, - { - "key": "sorters", - "value": "name" - }, - { - "key": "for-subadmin", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "cdf2a0b8-ad05-470f-8655-08a2b39d8e2e", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources?limit=50&offset=0&count=true&filters=name eq \"%23Employees\"&sorters=name&for-subadmin=name", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "limit", - "value": "50" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "filters", - "value": "name eq \"#Employees\"" - }, - { - "key": "sorters", - "value": "name" - }, - { - "key": "for-subadmin", - "value": "name" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Creates a source in IdentityNow.", - "id": "8ff11694-1357-4cc3-a990-e5d4b5253a1a", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources?provisionAsCsv=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "provisionAsCsv", - "value": "true", - "description": "Configures the source as a DelimitedFile type of source." - } - ], - "variable": [ - { - "id": "d991ffd2-a593-469a-a6a0-a30d3a98c5c4", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API." - }, - "response": [ - { - "id": "ba897dac-5aaa-4607-8fa0-535c1a0aa3c0", - "name": "Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources?provisionAsCsv=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "provisionAsCsv", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}" - }, - { - "id": "a57a3c1f-6555-4084-bf50-9383a712c16b", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources?provisionAsCsv=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "provisionAsCsv", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "1c04ac67-d8e7-4b6f-a78c-cc05710a0782", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources?provisionAsCsv=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "provisionAsCsv", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "9abfd580-c3f8-407e-b744-62f2d6b7d995", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources?provisionAsCsv=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "provisionAsCsv", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "22e19014-ce45-46c4-b485-0e0cea213cef", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources?provisionAsCsv=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "provisionAsCsv", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "9044485a-ea0c-46d0-a35c-6f7ed14e286f", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources?provisionAsCsv=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources" - ], - "query": [ - { - "key": "provisionAsCsv", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Source by ID", - "id": "e4a845bc-435c-4e47-816b-ba7e9ca8d938", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "id": "dd7b8c16-a510-4103-aaae-94a206de0cf1", - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "id": "7190f351-89d6-4f83-9c06-1354a7186584", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point gets a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API." - }, - "response": [ - { - "id": "24fca673-1909-4a7c-aee2-633d1ecfecc2", - "name": "A Source object", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}" - }, - { - "id": "2850344d-7922-43cd-9dc8-5152e8e93c5c", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "84ab505b-1a01-4650-9471-cfd9ad31062d", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "abb70ba6-85ac-45e9-8ea7-93c440fa6dad", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "6132e0fe-648f-4e53-9ba2-bb0ddc900f95", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "3a5a19dd-9342-443a-866c-a56d249c3c25", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "7a42fbf1-d897-4ded-84c1-8e75bba2d58b", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Source (Full)", - "id": "024f39f4-562c-4098-bf77-1d92920d5dc6", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "id": "75e42976-d181-4b92-97e2-9309496b15f5", - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "id": "4c38ce3e-8b34-4984-8133-c35c64fea367", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source\nconfiguration is completely replaced.\n\nSome fields are immutable and cannot be changed, such as:\n\n* id\n* type\n* authoritative\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\n" - }, - "response": [ - { - "id": "dfcdeb0f-eca1-45f5-a0e0-1379b0c8fd63", - "name": "Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}" - }, - { - "id": "d3d20156-e22b-4db3-ac26-89b59a04bacc", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "3338cc26-f64a-49ea-8474-0acfe628b066", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "1fde1150-b9c2-4863-a7e3-06d82867806c", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "1c5af57d-c2e3-4e9c-a0c5-654b88a111df", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "690ae616-552b-433b-b3dd-af252aeef575", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "9b5c4429-e2ec-491b-a02d-7aebff07830c", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Source (Partial)", - "id": "4cab1d96-c967-4c11-a1db-3b4ead2c6e2b", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "id": "37540f3a-43d3-40d1-a0a0-1dd42fe36166", - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "id": "d20f6ff2-1f61-47f4-8e5d-31041efd103f", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API partially updates a source in IdentityNow, using a list of patch operations according to the\n[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nSome fields are immutable and cannot be changed, such as:\n\n* id\n* type\n* authoritative\n* created\n* modified\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API.\n" - }, - "response": [ - { - "id": "6a2808e6-7e6f-4c37-aad8-bece2907740d", - "name": "Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}" - }, - { - "id": "4654e1ca-2acb-49f0-8b31-a15bfc6cd15a", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "9f51c40f-76fd-421d-aad9-23b9557eaf1b", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "5f0b60d8-f87b-426b-9e25-4d2ec67d4987", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "e1e670de-1038-4329-ac2e-e238baac346e", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "fe086741-b7ab-4503-906b-bb0df5c609f4", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "6daaf2db-deaa-462d-be6f-046013b21eac", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Source by ID", - "id": "0ec3e9d9-3296-4169-8d57-675837540687", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "id": "711cb803-65f6-4915-a706-fa0840c06a36", - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "id": "2a331dc7-baa9-4c32-ae79-d5e649cee2fe", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point deletes a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\nAll of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}`" - }, - "response": [ - { - "id": "3c5f2a63-8942-4145-b63e-e20b98ea1074", - "name": "Accepted - Returned if the request was successfully accepted into the system.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"type\": \"TASK_RESULT\",\n \"id\": \"2c91808779ecf55b0179f720942f181a\",\n \"name\": null\n}" - }, - { - "id": "36c5cb46-1009-4213-b19b-9c7335f97b2b", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "a5096641-40c6-42c1-bfd6-dada3014f6f3", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "020176ca-4c90-4d7e-991e-f31ac664fc12", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b442138c-cff3-491a-8612-8060b5a2393d", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "888844b0-1873-45eb-ac04-d59fa4fa5008", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "a28d830e-e839-427d-9861-3247dafb61f5", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Lists ProvisioningPolicies", - "id": "bbd4cfa9-f436-40b0-a254-92c6142905dc", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "id": "123e300c-fc54-4fd6-bdb2-3cc6758922c0", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "id": "90ade3a5-36e3-41b3-87f3-237a551574ed", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point lists all the ProvisioningPolicies in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "b4c2a47f-af5e-450c-aba6-8f0104d9d4d7", - "name": "List of ProvisioningPolicyDto objects", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"name\": \"nulla adipisicing ex\",\n \"description\": \"et culpa\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"et sed Lorem fugiat in\",\n \"description\": \"exercitation deserunt velit dolore\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]" - }, - { - "id": "16eefbbc-a394-40e6-852e-4f84385ece68", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "bdd6d805-35eb-44c4-b008-54004445d413", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "3c79f4e1-77c7-4123-9620-495696898ff6", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "93b9066b-20d5-4570-9717-a8c0880752e8", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "d0b1f269-aaa0-4520-b8f5-a3b838c14758", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "7a5de102-fd81-4532-bdb0-fc7ae428e6da", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create Provisioning Policy", - "id": "3040d214-8d4d-42e3-a814-d43e32b4bda8", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Account\",\n \"description\": \"Account Provisioning Policy\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"displayName\",\n \"transform\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"displayName\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"distinguishedName\",\n \"transform\": {\n \"type\": \"usernameGenerator\",\n \"attributes\": {\n \"sourceCheck\": true,\n \"patterns\": [\n \"CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n ],\n \"fn\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"ln\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"lastname\"\n }\n },\n \"fi\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 1\n }\n },\n \"fti\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 2\n }\n }\n }\n },\n \"attributes\": {\n \"cloudMaxUniqueChecks\": \"5\",\n \"cloudMaxSize\": \"100\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"description\",\n \"transform\": {\n \"type\": \"static\",\n \"attributes\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "id": "10d33b0e-1151-4541-9658-69f89d6e747f", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "id": "b1f32b37-b566-4d39-bd66-572fc8cb19c7", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.\nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "ce2de1af-2f21-474e-8d37-910b33945446", - "name": "Created ProvisioningPolicyDto object", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Account\",\n \"description\": \"Account Provisioning Policy\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"displayName\",\n \"transform\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"displayName\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"distinguishedName\",\n \"transform\": {\n \"type\": \"usernameGenerator\",\n \"attributes\": {\n \"sourceCheck\": true,\n \"patterns\": [\n \"CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n ],\n \"fn\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"ln\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"lastname\"\n }\n },\n \"fi\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 1\n }\n },\n \"fti\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 2\n }\n }\n }\n },\n \"attributes\": {\n \"cloudMaxUniqueChecks\": \"5\",\n \"cloudMaxSize\": \"100\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"description\",\n \"transform\": {\n \"type\": \"static\",\n \"attributes\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"Lorem\",\n \"description\": \"dolore enim\",\n \"usageType\": \"ASSIGN\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}" - }, - { - "id": "c969f1f0-58a4-4c1d-a450-583029af38f0", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Account\",\n \"description\": \"Account Provisioning Policy\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"displayName\",\n \"transform\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"displayName\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"distinguishedName\",\n \"transform\": {\n \"type\": \"usernameGenerator\",\n \"attributes\": {\n \"sourceCheck\": true,\n \"patterns\": [\n \"CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n ],\n \"fn\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"ln\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"lastname\"\n }\n },\n \"fi\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 1\n }\n },\n \"fti\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 2\n }\n }\n }\n },\n \"attributes\": {\n \"cloudMaxUniqueChecks\": \"5\",\n \"cloudMaxSize\": \"100\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"description\",\n \"transform\": {\n \"type\": \"static\",\n \"attributes\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "8751eb8e-30fb-4bdc-ba7c-f964955fdf9a", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Account\",\n \"description\": \"Account Provisioning Policy\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"displayName\",\n \"transform\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"displayName\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"distinguishedName\",\n \"transform\": {\n \"type\": \"usernameGenerator\",\n \"attributes\": {\n \"sourceCheck\": true,\n \"patterns\": [\n \"CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n ],\n \"fn\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"ln\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"lastname\"\n }\n },\n \"fi\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 1\n }\n },\n \"fti\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 2\n }\n }\n }\n },\n \"attributes\": {\n \"cloudMaxUniqueChecks\": \"5\",\n \"cloudMaxSize\": \"100\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"description\",\n \"transform\": {\n \"type\": \"static\",\n \"attributes\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "5cbc8335-6ce9-4a1a-8964-b0fe3f9d1f3a", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Account\",\n \"description\": \"Account Provisioning Policy\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"displayName\",\n \"transform\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"displayName\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"distinguishedName\",\n \"transform\": {\n \"type\": \"usernameGenerator\",\n \"attributes\": {\n \"sourceCheck\": true,\n \"patterns\": [\n \"CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n ],\n \"fn\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"ln\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"lastname\"\n }\n },\n \"fi\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 1\n }\n },\n \"fti\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 2\n }\n }\n }\n },\n \"attributes\": {\n \"cloudMaxUniqueChecks\": \"5\",\n \"cloudMaxSize\": \"100\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"description\",\n \"transform\": {\n \"type\": \"static\",\n \"attributes\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "0a566c78-2040-4324-ae3c-8c6e59896a1a", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Account\",\n \"description\": \"Account Provisioning Policy\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"displayName\",\n \"transform\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"displayName\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"distinguishedName\",\n \"transform\": {\n \"type\": \"usernameGenerator\",\n \"attributes\": {\n \"sourceCheck\": true,\n \"patterns\": [\n \"CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n ],\n \"fn\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"ln\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"lastname\"\n }\n },\n \"fi\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 1\n }\n },\n \"fti\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 2\n }\n }\n }\n },\n \"attributes\": {\n \"cloudMaxUniqueChecks\": \"5\",\n \"cloudMaxSize\": \"100\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"description\",\n \"transform\": {\n \"type\": \"static\",\n \"attributes\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "d3316c75-af7b-4b55-8821-82e948d4bc7d", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Account\",\n \"description\": \"Account Provisioning Policy\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"displayName\",\n \"transform\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"displayName\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"distinguishedName\",\n \"transform\": {\n \"type\": \"usernameGenerator\",\n \"attributes\": {\n \"sourceCheck\": true,\n \"patterns\": [\n \"CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n ],\n \"fn\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"ln\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"lastname\"\n }\n },\n \"fi\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 1\n }\n },\n \"fti\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 2\n }\n }\n }\n },\n \"attributes\": {\n \"cloudMaxUniqueChecks\": \"5\",\n \"cloudMaxSize\": \"100\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"description\",\n \"transform\": {\n \"type\": \"static\",\n \"attributes\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "3ed80832-0903-47f4-9f73-3afb8ab25f31", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Account\",\n \"description\": \"Account Provisioning Policy\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"displayName\",\n \"transform\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"displayName\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"distinguishedName\",\n \"transform\": {\n \"type\": \"usernameGenerator\",\n \"attributes\": {\n \"sourceCheck\": true,\n \"patterns\": [\n \"CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n ],\n \"fn\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"ln\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"lastname\"\n }\n },\n \"fi\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 1\n }\n },\n \"fti\": {\n \"type\": \"substring\",\n \"attributes\": {\n \"input\": {\n \"type\": \"identityAttribute\",\n \"attributes\": {\n \"name\": \"firstname\"\n }\n },\n \"begin\": 0,\n \"end\": 2\n }\n }\n }\n },\n \"attributes\": {\n \"cloudMaxUniqueChecks\": \"5\",\n \"cloudMaxSize\": \"100\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"description\",\n \"transform\": {\n \"type\": \"static\",\n \"attributes\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Provisioning Policy by UsageType", - "id": "6cdbce0f-ddf1-4e1c-abab-7730e9b30b78", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "id": "f7d50e29-686c-4fbf-8435-6ae9ca2a7fe8", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "id": "65692e37-a104-41ba-8d54-0db7d7d7a692", - "key": "usageType", - "value": "REGISTER", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "id": "e359b706-6804-4bb2-a5e5-6571748e323d", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API." - }, - "response": [ - { - "id": "a2d0ddeb-0ffe-426d-a978-a829a034d476", - "name": "The requested ProvisioningPolicyDto was successfully retrieved.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "REGISTER", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"Lorem\",\n \"description\": \"dolore enim\",\n \"usageType\": \"ASSIGN\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}" - }, - { - "id": "7249f7ff-cad0-478b-b181-42258753713e", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "REGISTER", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e8af6d7a-e17a-4d0e-bf05-970c2a686f32", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "REGISTER", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "89a3aafc-d17c-4a76-8e54-e7e22ced572c", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "REGISTER", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "6838bab9-dfc0-44de-b13c-e079a349353c", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "REGISTER", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "a4f6f0a2-3c6c-4894-84d6-2911179d5b30", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "REGISTER", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "c6ef136f-dec9-4e22-943b-b7528c22d7b2", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "REGISTER", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Provisioning Policy by UsageType", - "id": "b6853154-56e5-456c-a40c-b53f09793d07", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"officia sint non\",\n \"description\": \"ea aliqua nulla\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "id": "623e87fb-b119-4049-a32c-f1a997a1cd70", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "id": "d8d1214c-97fb-494a-8805-b7c4b9b33dc1", - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "id": "3177fde5-c0ec-4456-837a-d1066517075d", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API." - }, - "response": [ - { - "id": "cb51f6a0-bd51-4610-a6b2-22581fe9b8a9", - "name": "The ProvisioningPolicyDto was successfully replaced.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"enim ipsum sit\",\n \"description\": \"reprehenderit Excepteur consectetur deserunt eiusmod\",\n \"usageType\": \"CHANGE_PASSWORD\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"Lorem\",\n \"description\": \"dolore enim\",\n \"usageType\": \"ASSIGN\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}" - }, - { - "id": "ebbdd3a5-221b-4654-b3ec-c01ef69470dd", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"enim ipsum sit\",\n \"description\": \"reprehenderit Excepteur consectetur deserunt eiusmod\",\n \"usageType\": \"CHANGE_PASSWORD\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b67886e2-2f20-49ad-b5d4-6ac6d2ad049e", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"enim ipsum sit\",\n \"description\": \"reprehenderit Excepteur consectetur deserunt eiusmod\",\n \"usageType\": \"CHANGE_PASSWORD\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "292c46b5-960b-446a-b56b-57e3a03b72e7", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"enim ipsum sit\",\n \"description\": \"reprehenderit Excepteur consectetur deserunt eiusmod\",\n \"usageType\": \"CHANGE_PASSWORD\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "76a5a957-5661-4daf-9f46-08e5e8fdfcc4", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"enim ipsum sit\",\n \"description\": \"reprehenderit Excepteur consectetur deserunt eiusmod\",\n \"usageType\": \"CHANGE_PASSWORD\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "317f0dba-c6ef-428f-860a-f3538106a68b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"enim ipsum sit\",\n \"description\": \"reprehenderit Excepteur consectetur deserunt eiusmod\",\n \"usageType\": \"CHANGE_PASSWORD\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "d73eb493-fbc2-44c8-b566-88311d696d0d", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"enim ipsum sit\",\n \"description\": \"reprehenderit Excepteur consectetur deserunt eiusmod\",\n \"usageType\": \"CHANGE_PASSWORD\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Partial update of Provisioning Policy", - "id": "571e9cf1-dab4-4ccc-acef-3c943bd7e64b", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "id": "856fa1cc-5938-4461-9660-71f349a68816", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "d5456e44-3fc9-4ec2-a148-4dfad591a450", - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "id": "35c95c81-476b-4ae0-8067-edee935814f3", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API selectively updates an existing Provisioning Policy using a JSONPatch payload.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API." - }, - "response": [ - { - "id": "e47eb534-22e0-4b72-8c24-5be46185a23e", - "name": "The ProvisioningPolicyDto was successfully updated.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"Lorem\",\n \"description\": \"dolore enim\",\n \"usageType\": \"ASSIGN\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n}" - }, - { - "id": "144a0bd0-db10-4ab2-a1a7-63f982cb7fb3", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "ee281c82-be38-4d6a-af3f-5431a855cbc1", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "10788ac4-cf97-4a9f-b11c-c7f66aeb44e1", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "c28c8bc1-3c7a-4e03-9748-99f42b051666", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "198458ec-ef6f-4fca-9224-afa0a42fa53a", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "fba6c619-0450-4cd6-8c5a-ccfcfaca10fe", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Provisioning Policy by UsageType", - "id": "e1dc68b1-519e-4288-9821-77bdaeb6396a", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "id": "955bccfc-dd4c-47b4-949f-39451a20aa06", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "id": "c8d346ad-4d58-4d8d-adef-78e8e927fb93", - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "id": "4d85e077-2508-446c-8d6f-d521f7288597", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Deletes the provisioning policy with the specified usage on an application.\nA token with API, or ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "fa3b02ba-648c-43c8-a0fa-84f643923d6c", - "name": "The ProvisioningPolicyDto was successfully deleted.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "dfbeaa3c-14f6-4753-911a-097dcd2c22f5", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "cd5c67d1-4f7d-402d-b614-69dfcfe6435e", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "270604ed-8531-4cac-b20a-a7821dc58b05", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b76b1b6b-a3af-4675-ae04-0a44a94c0094", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "bdb5e1d0-0f2a-41da-b53f-a9965944179e", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "5067b810-9c2e-4a68-875d-b5345390605e", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/:usageType", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - ":usageType" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "usageType", - "value": "DELETE_GROUP", - "description": "(Required) The type of ProvisioningPolicy usage." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Bulk Update Provisioning Policies", - "id": "4c09e49f-0f3c-41c1-a361-c8a8cd3902ee", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"irure est\",\n \"description\": \"dolor ut\",\n \"usageType\": \"EDIT_GROUP\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"eu sunt consectetur\",\n \"description\": \"deserunt culpa sit nostrud\",\n \"usageType\": \"UPDATE_GROUP\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/bulk-update", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - "bulk-update" - ], - "variable": [ - { - "id": "bab59dfd-c851-4364-9eed-73063dc8dd10", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "13241c8f-4c27-461f-a48a-606543e2546e", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This end-point updates a list of provisioning policies on the specified source in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "81d19c3a-5cc1-4257-bccb-c9586ef140ab", - "name": "A list of the ProvisioningPolicyDto was successfully replaced.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"enim eu\",\n \"description\": \"nulla in do\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"aliquip velit\",\n \"description\": \"anim\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/bulk-update", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - "bulk-update" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"name\": \"nulla adipisicing ex\",\n \"description\": \"et culpa\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"et sed Lorem fugiat in\",\n \"description\": \"exercitation deserunt velit dolore\",\n \"usageType\": \"DELETE\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"isRequired\": false,\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]" - }, - { - "id": "7cdb1a63-4d67-4e2e-835e-ee183489aee5", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"enim eu\",\n \"description\": \"nulla in do\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"aliquip velit\",\n \"description\": \"anim\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/bulk-update", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - "bulk-update" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "f76fccc8-fbfd-4371-b494-1d552c9f5f76", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"enim eu\",\n \"description\": \"nulla in do\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"aliquip velit\",\n \"description\": \"anim\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/bulk-update", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - "bulk-update" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "0e3c915f-6233-4a93-9362-1a546638c9e7", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"enim eu\",\n \"description\": \"nulla in do\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"aliquip velit\",\n \"description\": \"anim\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/bulk-update", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - "bulk-update" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "cb33a9f7-9e0c-4feb-a5cf-c463b45084ed", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"enim eu\",\n \"description\": \"nulla in do\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"aliquip velit\",\n \"description\": \"anim\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/bulk-update", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - "bulk-update" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "dc0cbc75-c78f-4e16-a271-131ae12b4287", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"enim eu\",\n \"description\": \"nulla in do\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"aliquip velit\",\n \"description\": \"anim\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/bulk-update", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - "bulk-update" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "6f9a9099-0eb6-475a-bbb4-51c9180b1894", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"enim eu\",\n \"description\": \"nulla in do\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"aliquip velit\",\n \"description\": \"anim\",\n \"usageType\": \"REGISTER\",\n \"fields\": [\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"userName\",\n \"transform\": {\n \"type\": \"rule\",\n \"attributes\": {\n \"name\": \"Create Unique LDAP Attribute\"\n }\n },\n \"attributes\": {\n \"template\": \"${firstname}.${lastname}${uniqueCounter}\",\n \"cloudMaxUniqueChecks\": \"50\",\n \"cloudMaxSize\": \"20\",\n \"cloudRequired\": \"true\"\n },\n \"type\": \"string\",\n \"isMultiValued\": false\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/provisioning-policies/bulk-update", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "provisioning-policies", - "bulk-update" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "List Schemas on a Source", - "id": "2d818eda-04df-491d-b108-091b7806a526", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas?include-types=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "query": [ - { - "key": "include-types", - "value": "group", - "description": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized." - } - ], - "variable": [ - { - "id": "f05a54ad-49e5-4ad2-bf25-1517d1852bd9", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "id": "a1c4879b-63e7-4780-a70c-ae6ef186455b", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Lists the Schemas that exist on the specified Source in IdentityNow.\n" - }, - "response": [ - { - "id": "8c6fb77b-a5c9-4422-8e04-9ac3add6b49c", - "name": "The Schemas were successfully retrieved.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas?include-types=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "query": [ - { - "key": "include-types", - "value": "group" - } - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"ex culpa\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"esse dolor deserunt anim\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n },\n {\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"esse aliq\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n }\n]" - }, - { - "id": "6e16e2e4-0733-4e76-b593-bab5fcdedac2", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas?include-types=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "query": [ - { - "key": "include-types", - "value": "group" - } - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "b337c105-0452-4d86-8ac8-1d0a7a8fc5e8", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas?include-types=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "query": [ - { - "key": "include-types", - "value": "group" - } - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "76af6c15-89ec-4e46-8e31-b71a8485b308", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas?include-types=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "query": [ - { - "key": "include-types", - "value": "group" - } - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "d107c1b9-40ee-4f4b-acda-ecf0bbc9d86f", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas?include-types=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "query": [ - { - "key": "include-types", - "value": "group" - } - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "90b64f09-d5bd-460b-9c22-6609a45ada5d", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas?include-types=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "query": [ - { - "key": "include-types", - "value": "group" - } - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "636ddac0-443c-4d74-8328-5d0f1d47ac4c", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas?include-types=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "query": [ - { - "key": "include-types", - "value": "group" - } - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source ID." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create Schema on a Source", - "id": "45859d40-f138-4b9f-9e4a-b773c554b554", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"Lorem sint\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"Duis aliqua\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "variable": [ - { - "id": "ff6156e8-6c93-400e-aa8a-731002c7427a", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "edb43da4-9da9-47c1-bfbe-fe7b1cc80055", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Creates a new Schema on the specified Source in IdentityNow.\n" - }, - "response": [ - { - "id": "da87d3f8-34b4-41d6-8ce4-23bd6773c0f7", - "name": "The Schema was successfully created on the specified Source.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"voluptate Lorem ut enim\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"minim id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}" - }, - { - "id": "f9f017d3-eedf-41f0-9842-872cd13da6e3", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "5a0b6a82-3daa-4d6c-afe6-5289849b1946", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "5789373e-5600-4c3a-8139-6f51f7612a22", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "59fe32b4-d41e-425d-8fd6-4afafba03355", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "fc12d68f-2137-40e3-aa3e-ebd57f6b6676", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Source Schema by ID", - "id": "7257c360-c1d7-489e-9ff3-1e57b140e62c", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "id": "4bca632b-ccbf-49c7-95ae-78e8c43cd7da", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "8c1d9da6-1b63-4757-a12d-9616f6a26dc6", - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "id": "fe02ee6b-e799-47ac-bc99-8ff9a2b1084b", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Get the Source Schema by ID in IdentityNow.\n" - }, - "response": [ - { - "id": "90011e61-d128-4b49-a5d3-5c9f145390cb", - "name": "The requested Schema was successfully retrieved.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"voluptate Lorem ut enim\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"minim id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}" - }, - { - "id": "9ae7dc28-a89c-41bd-a685-f04f4b1f2f5b", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "70ebb076-7657-46a6-87c7-dad8ed7690e2", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "c480a181-a455-45a3-91f0-5f7ad064bd97", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "00cd8082-ea31-49e3-9fe2-517895738539", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "9a72e4a7-e9af-4524-8eef-a57c4a4bae52", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "96fabb37-5cf4-4ba8-b936-fbe8cc8abe28", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Source Schema (Full)", - "id": "5921dd4b-6cf8-438f-b263-0543d778c18a", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"Lorem sint\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"Duis aliqua\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "id": "e9a535c2-107e-4340-82fd-073816191688", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "c207ebd2-5939-4521-9f27-cef777e2a49c", - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "id": "2aeec07a-ddb2-49b3-8ae7-1e1cd9687b65", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.\n\n* id\n* name\n* created\n* modified\n\nAny attempt to modify these fields will result in an error response with a status code of 400.\n\n> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error.\n" - }, - "response": [ - { - "id": "c0ebebec-31b4-4c3f-a72e-5242b7416380", - "name": "The Schema was successfully replaced.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"voluptate Lorem ut enim\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"minim id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}" - }, - { - "id": "380324e5-1f68-4c0f-8abc-1049d8effccd", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "cfc7d6e6-49db-405e-841c-213a0c293bfa", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "3adfdf63-3bd5-48b7-ae21-32a9a6082223", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "be972824-e11d-41ea-93c8-12c17636ea37", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "37e921f6-013a-4cad-bb76-77b11ea2f5fc", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "5ceed502-3796-4cc2-9ec7-911676b7aca4", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"veniam commodo\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"amet id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Source Schema (Partial)", - "id": "31634bae-72c4-46a4-914f-3baac9efe45f", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "id": "d550812c-f5a7-4b3c-8edd-51d2cd21bf13", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "a1a0770e-403e-4920-ac50-dfb78af97731", - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "id": "c474b3b4-475d-40aa-b976-f0addf05f031", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API can be used to selectively update an existing Schema using a JSONPatch payload. Some fields of the Schema cannot be updated. These fields are listed below.\n* id\n* name\n* created\n* modified" - }, - "response": [ - { - "id": "659a2f68-bfcd-42b3-b628-81037415be2f", - "name": "The Schema was successfully updated.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"voluptate Lorem ut enim\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"minim id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}" - }, - { - "id": "9855c5ac-8ee7-41c4-943f-2bfc95051520", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e894e571-35a9-47fd-89f2-44223b80a782", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ec66b395-a2a2-412a-8521-ea84127f2681", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "2e56e8fd-20fe-4c3f-abbf-40b040eee9e6", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "a7c831ab-46ec-4f3a-96eb-4484873ddef1", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "e4c588ad-cc5e-448c-be70-75653741a126", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "[object Object]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete Source Schema by ID", - "id": "1da801c3-d0b6-41b6-94aa-9fa1915b7101", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "id": "df398897-e117-4957-bb36-5014788ac594", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "662eb9f3-75cd-464f-89d6-c2d4ca90398e", - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "id": "a1dd0bad-7a61-4ea7-98d5-eb377f35fc4c", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "response": [ - { - "id": "fde92873-eabb-4440-b524-13338a065f44", - "name": "The Schema was successfully deleted.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "98e37f2a-ba1c-4e71-93d7-885a3cb6311f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "895c9959-bff6-4d1d-a6fc-1ce7752d8920", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "4bef89ae-8314-4132-b985-dcd7ebc553fa", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "a1cc5e4f-0219-4110-a135-2cb29973522a", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "64b7a66c-38dc-45d2-be80-079318579c13", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "e6be478b-bd0f-4fcd-a19d-6f5b0b4cc59f", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/schemas/:schemaId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "schemas", - ":schemaId" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "schemaId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Schema id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "This API fetches source health by source's id", - "id": "92e31db0-da71-4f89-a92d-11dd68f4945e", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/source-health", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "source-health" - ], - "variable": [ - { - "id": "343cdb09-d77b-401c-adbc-231632395656", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "3e0b3a2c-fc83-4ac4-80fd-f9d5a1815632", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This endpoint fetches source health by source's id" - }, - "response": [ - { - "id": "8cb147ba-542a-4208-844b-1c65ea01ff76", - "name": "Fetched source health successfully", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/source-health", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "source-health" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"type\": \"OpenLDAP - Direct\",\n \"name\": \"Source1234\",\n \"org\": \"denali-cjh\",\n \"isAuthoritative\": false,\n \"isCluster\": false,\n \"hostname\": \"megapod-useast1-secret-hostname.sailpoint.com\",\n \"pod\": \"megapod-useast1\",\n \"iqServiceVersion\": \"iqVersion123\",\n \"status\": \"SOURCE_STATE_UNCHECKED_SOURCE\"\n}" - }, - { - "id": "ac823ba7-6ee2-41ec-8a16-0e7c41654695", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/source-health", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "source-health" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "6cd8f06b-3629-4d9d-a750-3028a2bec458", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/source-health", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "source-health" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "dc2f73ee-45cb-4cd0-8a3e-cc09419098e2", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/source-health", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "source-health" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "51d1ec1b-5bd3-4e25-9bba-dcb97983dba9", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/source-health", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "source-health" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "7dc569a5-e8ea-46f9-9861-b235e5ba39b1", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/source-health", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "source-health" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "6b8ce721-b74d-4d74-b436-aad534cb5009", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/source-health", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "source-health" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Downloads source accounts schema template", - "id": "2f8eaf05-06a9-4227-9513-71e6d371a3b6", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "text/csv" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "id": "ac97f5f2-d843-44ee-8795-caad4ff9fa86", - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "id": "921975b1-5181-4820-8a6f-4c3e06ff2838", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API downloads the CSV schema that defines the account attributes on a source.\n>**NOTE: This API is designated only for Delimited File sources.**" - }, - "response": [ - { - "id": "b90d8645-1430-4f49-b356-0449dacc3d13", - "name": "Successfully downloaded the file", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/csv" - } - ], - "cookie": [], - "responseTime": null, - "body": "id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate" - }, - { - "id": "dd90a1dc-eef9-4686-8d92-7026b62f9b50", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "a5f5e910-e2ad-4c58-a7c4-5d6d3c553919", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "d47333c3-8e20-4483-b000-80554b7be48f", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "a1cd7dbc-0dbc-431c-9471-c2b49f085855", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "d669eeca-c81b-4ab6-bfe8-f61e52a421bc", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "5138efc3-ad0d-4259-bfa9-a4c5fffc937b", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Uploads source accounts schema template", - "id": "c27b5f5b-0514-46f3-ab8e-1e690486e5ba", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "value": null - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "id": "5af5709f-92ac-4a4b-969e-eb9d38fe5a0a", - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "id": "9941e5e9-1966-4b0c-b994-eb1817d6f5b0", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API uploads a source schema template file to configure a source's account attributes.\n\nTo retrieve the file to modify and upload, log into Identity Now. \n\nClick **Admin** -> **Connections** -> **Sources** -> **``** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema**\n\n>**NOTE: This API is designated only for Delimited File sources.**" - }, - "response": [ - { - "id": "b505d94a-3e5a-4af5-8558-ac5d291ff901", - "name": "Successfully uploaded the file", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"voluptate Lorem ut enim\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"minim id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}" - }, - { - "id": "67f8a657-53e5-4d2b-b1b9-287e938ecb34", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "621572e9-361b-41bb-bdd5-3a402b011b94", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "2d24b971-265f-4daf-8975-1a57a8b29e8c", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "635ae9ef-87a8-4c67-bba1-bcb8c40a84e5", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "7412b683-fab9-45dd-9422-11cd03e5dd10", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/accounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "accounts" - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Downloads source entitlements schema template", - "id": "a999db2f-2f81-49d6-8012-0d13df2cb2f6", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "text/csv" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group", - "description": "Name of entitlement schema" - } - ], - "variable": [ - { - "id": "e8342f2c-61bd-46c8-8ded-cf120c33565c", - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "id": "b2f3b91a-90f6-4167-9fdb-c318992b8d4a", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API downloads the CSV schema that defines the entitlement attributes on a source.\n\n>**NOTE: This API is designated only for Delimited File sources.**" - }, - "response": [ - { - "id": "52a3877f-32e5-483d-9433-b8a4b0d9897d", - "name": "Successfully downloaded the file", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/csv" - } - ], - "cookie": [], - "responseTime": null, - "body": "id,name,displayName,created,description,modified,entitlements,groups,permissions" - }, - { - "id": "b5666c77-e8e2-41a9-9c2f-e5adcac75658", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "ccf60acc-a0e0-451c-a0c1-346e337a9626", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "a58266a7-d6a7-4460-903a-f83f05df2b37", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "3fc89465-37c9-477f-ad83-97a0b08578cc", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "8a537e51-518f-48db-8c6a-48060bacb4fc", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "ed416934-0f7e-4d29-89b1-679285e1f1b7", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Uploads source entitlements schema template", - "id": "b8766f3b-aa0d-454e-bd4d-173719096ee1", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "value": null - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group", - "description": "Name of entitlement schema" - } - ], - "variable": [ - { - "id": "2b7f6fbc-f290-4467-8fa8-8b0459893b46", - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "id": "8cc0b10b-6e3d-4a00-aba4-54c850e9a72d", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API uploads a source schema template file to configure a source's entitlement attributes.\n\nTo retrieve the file to modify and upload, log into Identity Now. \n\nClick **Admin** -> **Connections** -> **Sources** -> **``** -> **Import Data** -> **Import Entitlements** -> **Download**\n\n>**NOTE: This API is designated only for Delimited File sources.**" - }, - "response": [ - { - "id": "13cb1678-e63b-4a95-84e2-1e82b98e9e3f", - "name": "Successfully uploaded the file", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"voluptate Lorem ut enim\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n },\n \"description\": \"minim id\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}" - }, - { - "id": "96c72cad-4de0-408e-aef1-ebb5260695dd", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "9cb755dd-087f-4bad-9f5a-b42ad5e41061", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "0d783a87-de40-4cde-9a6a-38d4f436f5b5", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "98b3f9f9-4d8f-4090-957f-5c0aa58b2701", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "890036fe-e96a-4167-8c17-707e7b9d20dc", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:id/schemas/entitlements?schemaName=?schemaName=group", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":id", - "schemas", - "entitlements" - ], - "query": [ - { - "key": "schemaName", - "value": "?schemaName=group" - } - ], - "variable": [ - { - "key": "id", - "value": "8c190e6787aa4ed9a90bd9d5344523fb", - "description": "(Required) The Source id" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Upload connector file to source", - "id": "e9f0fa76-5fc0-40ff-b166-b0c6e6e89d52", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "value": null - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/upload-connector-file", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "upload-connector-file" - ], - "variable": [ - { - "id": "0229af93-de8c-43f3-8db7-6c589b6ed03b", - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "id": "5c89d10e-47e9-4c04-b6a3-84f29ef1eb91", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.\nA token with ORG_ADMIN authority is required to call this API." - }, - "response": [ - { - "id": "52cb2731-91e6-43d9-a01f-d9f4575a31aa", - "name": "Uploaded the file successfully and sent all post-upload events", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/upload-connector-file", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "upload-connector-file" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"manager\",\n \"identityAttribute\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"name\": \"Corporate Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementstionId\": \"delimited-file\"\n}" - }, - { - "id": "ca8ae3ad-aecc-4196-8167-4a914994e6a1", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/upload-connector-file", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "upload-connector-file" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "0dfa93f2-b5f4-4ed8-b7e1-5e5c05929a9c", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/upload-connector-file", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "upload-connector-file" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "0c6536ae-000e-4d8e-96e8-7085ce1cc538", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/upload-connector-file", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "upload-connector-file" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "48bc66d9-0850-4817-9384-17b084552522", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/upload-connector-file", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "upload-connector-file" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "3a488d6a-6495-4530-94d3-57bb093b1933", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/sources/:sourceId/upload-connector-file", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sources", - ":sourceId", - "upload-connector-file" - ], - "variable": [ - { - "key": "sourceId", - "value": "2c9180835d191a86015d28455b4a2329", - "description": "(Required) The Source id." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "7f8b1c6d-dd78-4e21-ac94-3002e7af97be" - }, - { - "name": "Transforms", - "item": [ - { - "name": "List transforms", - "id": "f6be6e63-4dc0-4c6f-8374-e0c5185e67a7", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms?offset=0&limit=250&count=true&name=ExampleTransformName123&filters=name eq \"Uppercase\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "query": [ - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "name", - "value": "ExampleTransformName123", - "description": "Name of the transform to retrieve from the list." - }, - { - "key": "filters", - "value": "name eq \"Uppercase\"", - "description": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**internal**: *eq*\n**name**: *eq*, *sw*" - } - ], - "variable": [ - { - "id": "0294c35c-e1bf-4591-b733-db7996fdc64a", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Gets a list of all saved transform objects.\nA token with transforms-list read authority is required to call this API." - }, - "response": [ - { - "id": "9188b8d5-e80b-42e6-9411-200e14d4b6a5", - "name": "A list of transforms matching the given criteria.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms?offset=0&limit=250&count=true&name=ExampleTransformName123&filters=name eq \"Uppercase\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "name", - "value": "ExampleTransformName123" - }, - { - "key": "filters", - "value": "name eq \"Uppercase\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2cd78adghjkja34jh2b1hkjhasuecd\",\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n },\n \"internal\": false\n },\n {\n \"id\": \"2lkas8dhj4bkuakja77giih7l4ashh\",\n \"name\": \"PrefixSubstring\",\n \"type\": \"substring\",\n \"attributes\": {\n \"begin\": 0,\n \"end\": 3\n },\n \"internal\": true\n }\n]" - }, - { - "id": "9a6068a1-8c08-4719-b5b6-33eb8f7af5bb", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms?offset=0&limit=250&count=true&name=ExampleTransformName123&filters=name eq \"Uppercase\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "name", - "value": "ExampleTransformName123" - }, - { - "key": "filters", - "value": "name eq \"Uppercase\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "9b00ba33-84b3-4a08-9530-d84f1495f5fd", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms?offset=0&limit=250&count=true&name=ExampleTransformName123&filters=name eq \"Uppercase\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "name", - "value": "ExampleTransformName123" - }, - { - "key": "filters", - "value": "name eq \"Uppercase\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "98779dbb-81fc-4d8c-ae9c-6635275831aa", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms?offset=0&limit=250&count=true&name=ExampleTransformName123&filters=name eq \"Uppercase\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "name", - "value": "ExampleTransformName123" - }, - { - "key": "filters", - "value": "name eq \"Uppercase\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "3aba5a68-746e-4d0f-867d-5669b80f4e95", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms?offset=0&limit=250&count=true&name=ExampleTransformName123&filters=name eq \"Uppercase\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "name", - "value": "ExampleTransformName123" - }, - { - "key": "filters", - "value": "name eq \"Uppercase\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "b0e148b9-e199-41a2-8f17-8e37157a0e70", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms?offset=0&limit=250&count=true&name=ExampleTransformName123&filters=name eq \"Uppercase\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "name", - "value": "ExampleTransformName123" - }, - { - "key": "filters", - "value": "name eq \"Uppercase\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "1156e567-a81e-4342-adc6-db8e0855e2dc", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms?offset=0&limit=250&count=true&name=ExampleTransformName123&filters=name eq \"Uppercase\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "query": [ - { - "key": "offset", - "value": "0" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "name", - "value": "ExampleTransformName123" - }, - { - "key": "filters", - "value": "name eq \"Uppercase\"" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create transform", - "id": "743cddfc-e513-42b7-a1a8-9fe1d57273df", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM dd yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "variable": [ - { - "id": "d6cb966f-12db-487c-bcfd-d2635c0fa1ba", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API." - }, - "response": [ - { - "id": "f6913e6a-ce74-4b9b-9985-5c7c4f61800c", - "name": "Indicates the transform was successfully created and returns its representation.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM dd yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"sourceName\": \"Workday\",\n \"attributeName\": \"DEPARTMENT\",\n \"accountSortAttribute\": \"created\",\n \"accountSortDescending\": \"ut dolor dolor consequat Duis\",\n \"accountReturnFirstLink\": \"qui commodo labo\",\n \"accountFilter\": \"!(nativeIdentity.startsWith(\\\"*DELETED*\\\"))\",\n \"accountPropertyFilter\": \"(groups.containsAll({'Admin'}) || location == 'Austin')\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"attributeName\": \"first_name\",\n \"sourceName\": \"Source\"\n }\n }\n },\n \"id\": \"2cd78adghjkja34jh2b1hkjhasuecd\",\n \"internal\": false\n}" - }, - { - "id": "d847f84a-a5b4-492a-bcfa-fe208a68d11f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM dd yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "88d4c246-b10c-43be-b8d4-3aca071aa201", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM dd yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "7c2170ca-fac4-4fd8-b464-43b9f03c2eab", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM dd yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "b435a32f-1641-4e1e-9c44-d19735c8fd33", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM dd yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "7ddff37d-38b0-4703-bd99-a1610851fb7e", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM dd yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "b9885029-91bc-4f9c-be20-c50d096df018", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM dd yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms" - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Transform by ID", - "id": "43533c96-2eaf-4f3b-ab41-c3a14bbc22fe", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "id": "42a34cdd-31c0-4e5d-b419-f66df2a6a097", - "key": "id", - "value": "2cd78adghjkja34jh2b1hkjhasuecd", - "description": "(Required) ID of the transform to retrieve" - }, - { - "id": "c862e17a-4879-4918-a2b1-3c4c1465aff0", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API returns the transform specified by the given ID.\nA token with transform read authority is required to call this API." - }, - "response": [ - { - "id": "1ade123d-86d1-40b8-9add-bcbeff111bd8", - "name": "Transform with the given ID", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2cd78adghjkja34jh2b1hkjhasuecd", - "description": "(Required) ID of the transform to retrieve" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"sourceName\": \"Workday\",\n \"attributeName\": \"DEPARTMENT\",\n \"accountSortAttribute\": \"created\",\n \"accountSortDescending\": \"ut dolor dolor consequat Duis\",\n \"accountReturnFirstLink\": \"qui commodo labo\",\n \"accountFilter\": \"!(nativeIdentity.startsWith(\\\"*DELETED*\\\"))\",\n \"accountPropertyFilter\": \"(groups.containsAll({'Admin'}) || location == 'Austin')\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"attributeName\": \"first_name\",\n \"sourceName\": \"Source\"\n }\n }\n },\n \"id\": \"2cd78adghjkja34jh2b1hkjhasuecd\",\n \"internal\": false\n}" - }, - { - "id": "ca7f1ef2-0146-4593-9171-7866c8ad2b2f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2cd78adghjkja34jh2b1hkjhasuecd", - "description": "(Required) ID of the transform to retrieve" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "60ea4f02-40de-4eba-a715-220a1c6c76ab", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2cd78adghjkja34jh2b1hkjhasuecd", - "description": "(Required) ID of the transform to retrieve" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "7df53064-6352-4228-af19-76076c1176dc", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2cd78adghjkja34jh2b1hkjhasuecd", - "description": "(Required) ID of the transform to retrieve" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "dad77205-da41-4725-bc85-ba6849b71219", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2cd78adghjkja34jh2b1hkjhasuecd", - "description": "(Required) ID of the transform to retrieve" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "d9fae8f8-8766-4323-b8c1-85a7196ff294", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2cd78adghjkja34jh2b1hkjhasuecd", - "description": "(Required) ID of the transform to retrieve" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "f59d3e06-fe8b-4491-9ccf-cd9a4f06af00", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "2cd78adghjkja34jh2b1hkjhasuecd", - "description": "(Required) ID of the transform to retrieve" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update a transform", - "id": "1444e3f8-17c0-494b-9420-c347fa99599c", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "id": "59e6a2c1-dd6c-451c-9089-bdcac678fbef", - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to update" - }, - { - "id": "1fcef6cc-5d33-45ac-8384-dfe3ae081305", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error.\nA token with transform write authority is required to call this API." - }, - "response": [ - { - "id": "90dc0c28-e3e7-4874-adab-4ce17edad609", - "name": "Indicates the transform was successfully updated and returns its new representation.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2cd78adghjkja34jh2b1hkjhasuecd\",\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n },\n \"internal\": false\n}" - }, - { - "id": "9c0d54b1-08f9-4d6f-b99d-484633103135", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "822635c2-d9e2-4e7c-a3b1-d9c18f5a0d5f", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "3ea6e7f8-806c-4cca-bae2-f6a1716d4064", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "fa530b90-d612-4047-8877-fd8e35d76493", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "74bcb9db-d113-49b1-8ebf-6379c69f89ad", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "1979b8f9-b5fa-461c-9b0b-6401d6003f60", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Timestamp To Date\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"inputFormat\": \"MMM-dd-yyyy, HH:mm:ss.SSS\",\n \"outputFormat\": \"yyyy/dd/MM\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to update" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete a transform", - "id": "ee83c51f-60ac-4313-abb0-c322907fd1b9", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "id": "845e2c62-9965-49e1-a048-40ac5acb3be9", - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to delete" - }, - { - "id": "d6f7f71d-337f-49e0-95e0-06a7146969a7", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform.\nA token with transform delete authority is required to call this API." - }, - "response": [ - { - "id": "fc726b74-8f6e-47ea-a709-21eadbd4ed03", - "name": "No content - indicates the request was successful but there is no content to be returned in the response.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "responseTime": null, - "body": "" - }, - { - "id": "2583f21f-8d6d-4bd2-85ac-4c5e66f0a577", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "238424e8-1593-4cb1-aabb-c791fc638831", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "80809404-ae88-45a5-81e2-c6d2bb38d293", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "25f92673-fb9a-4411-b00e-5f8bf580032f", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "49332cbe-0916-4eff-9b51-fcad58b68a26", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "33fbb4b1-5c33-450a-bbca-f9eea6f4c4bd", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/transforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the transform to delete" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "9f6c1d89-d50f-4cb5-ba37-6dcde9a45ef1", - "description": "The purpose of this API is to expose functionality for the manipulation of Transform objects.\nTransforms are a form of configurable objects which define an easy way to manipulate attribute data without having\nto write code. These endpoints don't require API calls to other resources, audit service is used for keeping track\nof which users have made changes to the Transforms.\n" - }, - { - "name": "Work Items", - "item": [ - { - "name": "List Work Items", - "id": "f652e574-cf0a-41ba-84f9-dff9796211e9", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items?limit=250&offset=0&count=true&ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items" - ], - "query": [ - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "ownerId", - "value": "eu", - "description": "ID of the work item owner." - } - ], - "variable": [ - { - "id": "dbaf543b-4b2e-487b-8745-ce64f2f0d5e5", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a collection of work items belonging to either the specified user(admin required), or the current user." - }, - "response": [ - { - "id": "c18f2f74-ae17-4329-8cf8-09f44b41c277", - "name": "List of work items", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items?limit=250&offset=0&count=true&ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"CANCELED\",\n \"type\": \"CERTIFICATION\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"PENDING\",\n \"type\": \"IMPACTANALYSIS\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n }\n]" - }, - { - "id": "60bf7be3-3718-41ad-8949-65230e0d5208", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items?limit=250&offset=0&count=true&ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "8fb84e46-6a3a-4d71-bf66-b9c2a65af0ff", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items?limit=250&offset=0&count=true&ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "23dd56a7-6aed-4412-8671-0fcd59300d7a", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items?limit=250&offset=0&count=true&ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "a39a5b87-9cda-4624-acb8-c679ea3f43a7", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items?limit=250&offset=0&count=true&ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "867aa31a-4c4d-4f1c-b875-ac38b0525b97", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items?limit=250&offset=0&count=true&ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items" - ], - "query": [ - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - }, - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Completed Work Items", - "id": "714e15f5-a06d-4e3d-a6da-b5e2f9290c62", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed?ownerId=eu&limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed" - ], - "query": [ - { - "key": "ownerId", - "value": "eu", - "description": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request." - }, - { - "key": "limit", - "value": "250", - "description": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "offset", - "value": "0", - "description": "Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - }, - { - "key": "count", - "value": "true", - "description": "If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information." - } - ], - "variable": [ - { - "id": "0ff2d1d1-eb63-4ce9-bf2f-ecd3e6b0ab9c", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a collection of completed work items belonging to either the specified user(admin required), or the current user." - }, - "response": [ - { - "id": "4b0c1d41-b3f1-4641-9f46-9d4ad41efe7a", - "name": "List of completed work items.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed?ownerId=eu&limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "[\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"CANCELED\",\n \"type\": \"CERTIFICATION\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n },\n {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"PENDING\",\n \"type\": \"IMPACTANALYSIS\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n }\n]" - }, - { - "id": "761e246d-c056-491f-9ac8-721f7695bc56", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed?ownerId=eu&limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "b6e56792-9267-43ca-b66f-09a396cb888f", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed?ownerId=eu&limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "d90749c3-c0ba-4171-b651-e597e4a8e49c", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed?ownerId=eu&limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "41ff7c72-4d42-4a8e-9bd7-c1efe6c0dbe2", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed?ownerId=eu&limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "09ef57d2-4cb1-4bf3-a388-f714a619d248", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed?ownerId=eu&limit=250&offset=0&count=true", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - }, - { - "key": "limit", - "value": "250" - }, - { - "key": "offset", - "value": "0" - }, - { - "key": "count", - "value": "true" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Count Work Items", - "id": "53cb344f-c1a2-4ad9-920e-b6960f390b2e", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu", - "description": "ID of the work item owner." - } - ], - "variable": [ - { - "id": "4ca7ade3-b967-48a8-8ee3-04238376b754", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a count of work items belonging to either the specified user(admin required), or the current user." - }, - "response": [ - { - "id": "d38ec010-a208-431d-bc25-78cd4a3290c8", - "name": "List of work items", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"count\": 29\n}" - }, - { - "id": "2bdd269c-fade-4047-b518-058594dace70", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "ddbc223f-6084-4232-8ce4-dc40d3164444", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "a86531d7-3225-480d-8844-3d167163ea3b", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "b67ad59b-81a8-4fc8-8dc5-df79d18b3bf7", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "05224a70-c789-4d64-b9a5-08c7b1c35232", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Count Completed Work Items", - "id": "50d1b625-5edc-4962-a76f-c83e463fb14c", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu", - "description": "ID of the work item owner." - } - ], - "variable": [ - { - "id": "8a8ce4a3-d5eb-4dc2-bbb5-c736147c37fc", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a count of completed work items belonging to either the specified user(admin required), or the current user." - }, - "response": [ - { - "id": "39a35614-67e8-4228-90e0-e63abd70003d", - "name": "List of work items", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"count\": 29\n}" - }, - { - "id": "c3e34cdb-bc39-4b5a-8f35-9772527d043b", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "a9386123-b33a-4fac-97bc-651da7b528f5", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "07f25af8-f1e3-4a0f-a4a5-27c4ac28388a", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "b67d7223-a3aa-4a22-a67a-dcf7a635cb09", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "347f8295-8957-49a6-b241-844af655c83c", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/completed/count?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "completed", - "count" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Work Items Summary", - "id": "f0898e63-6bd3-47aa-877c-5f9dbe033c14", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/summary?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "summary" - ], - "query": [ - { - "key": "ownerId", - "value": "eu", - "description": "ID of the work item owner." - } - ], - "variable": [ - { - "id": "f52fba9a-6d66-420c-b918-ad193747ff8e", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets a summary of work items belonging to either the specified user(admin required), or the current user." - }, - "response": [ - { - "id": "90c7b763-1a84-4b94-a985-1241b794fd09", - "name": "List of work items", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/summary?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "summary" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"open\": 29,\n \"completed\": 1,\n \"total\": 30\n}" - }, - { - "id": "e20705fb-d49d-45c9-aba7-159b7f26ba1b", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/summary?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "summary" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "a9c0d028-a1c1-480b-889a-32571750a3b7", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/summary?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "summary" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "af873b18-e043-4951-9ef1-e558ef5c4f8a", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/summary?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "summary" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "dcfa3f61-b9a8-4e49-b42a-d91985d75dd5", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/summary?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "summary" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "507653c7-67ee-44be-a423-96a46dad4333", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/summary?ownerId=eu", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "summary" - ], - "query": [ - { - "key": "ownerId", - "value": "eu" - } - ], - "variable": [ - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get a Work Item", - "id": "287e6a3d-9a09-4480-9235-f1d539dc4ec4", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "id": "c5ca869a-e3e6-49ef-8f2b-c3f16f70a968", - "key": "id", - "value": "eu", - "description": "(Required) ID of the work item." - }, - { - "id": "87f9cf66-acf8-42fb-9d4e-97ba3b1c5f9a", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This gets the details of a Work Item belonging to either the specified user(admin required), or the current user." - }, - "response": [ - { - "id": "21476842-7aba-4609-998b-79954a41a116", - "name": "The work item with the given ID.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the work item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"FINISHED\",\n \"type\": \"VIOLATIONREVIEW\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n}" - }, - { - "id": "78389805-6761-46f6-bf2a-96363c1aa825", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the work item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "b324ab39-cacf-4d11-be0b-6ff2e24c20fc", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the work item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "ee663d98-f01e-4217-8a7a-d2776f3e8acc", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the work item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "ce45d3ba-0912-465a-9431-28b2bddff7b5", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the work item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "5cef916b-e738-42c7-8fe9-563ef702a50d", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "eu", - "description": "(Required) ID of the work item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Complete a Work Item", - "id": "58b5f8ad-3321-4fd8-8a99-c2f9d2df5d98", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "id": "cee6e6ec-1fcb-40d8-a0ed-a2f56c984586", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "id": "f8036f59-cb64-403a-86ee-cd40b8e08fbf", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API completes a work item. Either an admin, or the owning/current user must make this request." - }, - "response": [ - { - "id": "2fd40819-2fd9-4fb1-8296-7ff13a2378ba", - "name": "A WorkItems object", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"FINISHED\",\n \"type\": \"VIOLATIONREVIEW\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n}" - }, - { - "id": "77a12b74-a731-4938-aa50-4f1fb9945a9f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "db40f3a2-c03f-459e-b412-49f41ac6bf6f", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "cfc9331b-8002-4a12-90ec-2308a46a0ac6", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "9b862ec4-493b-4459-96f2-877836cd9a06", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "ac252b33-6aa8-4969-8e56-47c9b544c5e3", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "a5e7a1a6-21b4-4113-85f3-af8bec0f4ee8", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Approve an Approval Item", - "id": "5a51f3ec-8dcf-4e30-9304-dc1459b114a2", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/approve/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "approve", - ":approvalItemId" - ], - "variable": [ - { - "id": "a3242332-dabf-4df2-971f-e7c5bbb270ba", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "id": "7c2b5412-0264-44e9-a26f-bfebfbe54a7f", - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "id": "a9670c7e-b50e-42ee-b3fa-5ee5be599689", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API approves an Approval Item. Either an admin, or the owning/current user must make this request." - }, - "response": [ - { - "id": "bae2be5e-3c84-4760-887e-60dc25e2fd3a", - "name": "A work items details object.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/approve/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "approve", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"FINISHED\",\n \"type\": \"VIOLATIONREVIEW\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n}" - }, - { - "id": "01cc2264-1a08-423e-b9bc-b9ff7f58d60a", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/approve/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "approve", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "eaff36a8-2e60-40d6-a498-26593a79ede3", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/approve/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "approve", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "c7724135-4ea3-492b-90b9-2a99927dc51b", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/approve/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "approve", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "167c7555-3690-438a-abd0-a8619b011da1", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/approve/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "approve", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "baada29a-3528-4382-a8d5-88bece1ee0a2", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/approve/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "approve", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "8bf69b32-b341-49a3-a0cd-e2b214f59cbf", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/approve/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "approve", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Reject an Approval Item", - "id": "778b3a03-bc06-4440-b4ee-fc065f26f85a", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/reject/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "reject", - ":approvalItemId" - ], - "variable": [ - { - "id": "2b7ac003-123c-4704-9a76-39b2e5a400b1", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "id": "0356a216-d55d-40bb-8ce3-dd95c74ec67c", - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "id": "180e3580-7dc0-4eb3-9308-df84f697b5df", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API rejects an Approval Item. Either an admin, or the owning/current user must make this request." - }, - "response": [ - { - "id": "87fb168c-3597-4d3e-8bd6-39a38b1a5b7c", - "name": "A work items details object.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/reject/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "reject", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"FINISHED\",\n \"type\": \"VIOLATIONREVIEW\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n}" - }, - { - "id": "3e3043de-9b70-4914-b95b-217452fd8ac9", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/reject/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "reject", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "e960398c-893b-4ed6-85de-29da1a20d832", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/reject/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "reject", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "835764a3-2af8-4b43-b628-5c089cc99a73", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/reject/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "reject", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "248f40dc-f0a4-4a2f-8d69-8cb428bc1ba2", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/reject/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "reject", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "77940d3d-947d-46f7-b42c-9b989f5fc547", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/reject/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "reject", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "e85c2565-2b8a-449b-8890-ecdf5acba0c2", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/:id/reject/:approvalItemId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "reject", - ":approvalItemId" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "approvalItemId", - "value": "1211bcaa32112bcef6122adb21cef1ac", - "description": "(Required) The ID of the approval item." - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Bulk approve Approval Items", - "id": "15c6a164-6257-4fc1-a9cf-9f3507bac56d", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-approve/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-approve", - ":id" - ], - "variable": [ - { - "id": "0f28b92c-ebf2-4e65-a08d-447eb5bdfcf8", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "id": "0af68081-c19e-45d2-aa62-6a8f3d0fef11", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request." - }, - "response": [ - { - "id": "ee782e8b-e803-40a1-b67a-51055c4c7a2a", - "name": "A work items details object.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-approve/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-approve", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"FINISHED\",\n \"type\": \"VIOLATIONREVIEW\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n}" - }, - { - "id": "145db52e-480a-436e-bae0-a07257c70042", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-approve/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-approve", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "9fb8e8c9-fb0f-464f-8b00-ac954a5fa762", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-approve/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-approve", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "95f722dd-9ba8-45bd-968c-3e5f0542826a", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-approve/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-approve", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "f0d1bc66-0299-4dcb-b857-018c189848cb", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-approve/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-approve", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "ad93fcf5-4a59-4177-9f58-53ae1159f304", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-approve/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-approve", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "17540425-a91e-405d-84b8-64cd8135e16c", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-approve/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-approve", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Bulk reject Approval Items", - "id": "0701d3b0-7ce4-4077-9c2a-dc653a8325ca", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-reject/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-reject", - ":id" - ], - "variable": [ - { - "id": "500c97c6-78fc-4472-b1c0-c40833124ffb", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "id": "7be862e7-b961-4b8a-a1f5-a5ea807f9a03", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request." - }, - "response": [ - { - "id": "915291eb-7616-4de2-83b7-8b29ea9d0e68", - "name": "A work items details object.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-reject/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-reject", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"FINISHED\",\n \"type\": \"VIOLATIONREVIEW\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n}" - }, - { - "id": "39ef0cfc-582c-4bb8-9741-ecec5ae44c65", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-reject/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-reject", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "c8b36c79-d997-4eb4-b5fb-4c4eb655938d", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-reject/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-reject", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "99c3cee3-f014-47e0-8890-b0d79caa0058", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-reject/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-reject", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "c81827ce-f5d3-4cfa-acc2-726e7353d3e0", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-reject/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-reject", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "cfa1cb93-3322-4f89-8488-493214e2a6aa", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-reject/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-reject", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "386b7f25-7214-4d1c-b74b-0f6bef9baf6f", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "url": { - "raw": "{{baseUrl}}/work-items/bulk-reject/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - "bulk-reject", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - }, - { - "name": "Submit Account Selections", - "id": "a928f8b6-418a-4d1d-bc1c-becd7d8a746c", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"fieldName\": \"fieldValue\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/work-items/:id/submit-account-selection", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "submit-account-selection" - ], - "variable": [ - { - "id": "54bedc29-0ffb-446f-b9d8-3d3cf4d6cd52", - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "id": "1c002859-34c8-441e-8583-eb89d2770f6d", - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - }, - "description": "This API submits account selections. Either an admin, or the owning/current user must make this request." - }, - "response": [ - { - "id": "1ee6d0ea-8aef-4f51-bf5a-7eae4ee47b25", - "name": "A work items details object.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"fieldName\": \"fieldValue\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/work-items/:id/submit-account-selection", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "submit-account-selection" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"requesterDisplayName\": \"John Smith\",\n \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"ownerName\": \"Jason Smith\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Create account on source 'AD'\",\n \"state\": \"FINISHED\",\n \"type\": \"VIOLATIONREVIEW\",\n \"remediationItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"attributeName\": \"emailAddress\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"a@b.com\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": {\n \"name\": \"Field1\",\n \"label\": \"Section 1\"\n }\n },\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n}" - }, - { - "id": "7df92d56-8e15-4bc2-b3fc-cdefcac92d8f", - "name": "Client Error - Returned if the request body is invalid.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"fieldName\": \"fieldValue\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/work-items/:id/submit-account-selection", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "submit-account-selection" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n },\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}" - }, - { - "id": "fe19f05d-2704-4454-99e6-8b803a4c6da3", - "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"fieldName\": \"fieldValue\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/work-items/:id/submit-account-selection", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "submit-account-selection" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"error\": {}\n}" - }, - { - "id": "49601d67-2d2b-450e-8a06-fb0c906902ac", - "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"fieldName\": \"fieldValue\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/work-items/:id/submit-account-selection", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "submit-account-selection" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}" - }, - { - "id": "eec5c2c7-8427-4336-8747-e63ce49fec79", - "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"fieldName\": \"fieldValue\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/work-items/:id/submit-account-selection", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "submit-account-selection" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}" - }, - { - "id": "ccc7afa4-d11e-4d19-82dd-4f178d189b7b", - "name": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"fieldName\": \"fieldValue\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/work-items/:id/submit-account-selection", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "submit-account-selection" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Too Many Requests", - "code": 429, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"message\": {}\n}" - }, - { - "id": "d577e23e-017e-4858-b211-4cb13e168b01", - "name": "Internal Server Error - Returned if there is an unexpected error.", - "originalRequest": { - "method": "POST", - "header": [ - { - "description": "Added as a part of security scheme: oauth2", - "key": "Authorization", - "value": "" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"fieldName\": \"fieldValue\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/work-items/:id/submit-account-selection", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "work-items", - ":id", - "submit-account-selection" - ], - "variable": [ - { - "key": "id", - "value": "ef38f94347e94562b5bb8424a56397d8", - "description": "(Required) The ID of the work item" - }, - { - "key": "tenant", - "value": "{{tenant}}", - "description": "This is the name of your tenant, typically your company's name." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "responseTime": null, - "body": "{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}" - } - ] - } - ], - "id": "796421df-d99f-420b-8659-51da57509bea", - "description": "Use this API to implement work item functionality. \nWith this functionality in place, users can manage their work items (tasks). \n\nWork items refer to the tasks users see in IdentityNow's Task Manager. \nThey can see the pending work items they need to complete, as well as the work items they have already completed. \nTask Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. \nFor example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. \nOnce the user completes the work item, the work item will be listed with his or her other completed work items. \n\nTo complete work items, users can use their dashboards and select the 'My Tasks' widget. \nThe widget will list any work items they need to complete, and they can select the work item from the list to review its details. \nWhen they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. \n\nRefer to the following link for more information about work items, like the different types of work items users may need to complete:\n" - } - ], - "auth": { - "type": "oauth2", - "oauth2": [ - { - "key": "scope", - "value": "sp:scopes:default sp:scopes:all", - "type": "string" - }, - { - "key": "accessTokenUrl", - "value": "https://tenant.api.identitynow.com/oauth/token", - "type": "string" - }, - { - "key": "grant_type", - "value": "client_credentials", - "type": "string" - } - ] - }, - "variable": [ - { - "id": "d3bcc623-819c-4484-a930-281d53f9177b", - "key": "tenant", - "value": "sailpoint", - "type": "any", - "description": "This is the name of your tenant, typically your company's name." - }, - { - "id": "b20ed608-ac67-4a0c-9f63-3857b726f25a", - "key": "baseUrl", - "value": "https://{{tenant}}.api.identitynow.com/v3", - "type": "string" - } - ] -} \ No newline at end of file diff --git a/postman/schemas/sailpoint-api.v3.yaml b/postman/schemas/sailpoint-api.v3.yaml deleted file mode 100644 index 10b7f40..0000000 --- a/postman/schemas/sailpoint-api.v3.yaml +++ /dev/null @@ -1,93529 +0,0 @@ -openapi: 3.0.1 -info: - title: IdentityNow V3 API - description: 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.' - termsOfService: 'https://developer.sailpoint.com/discuss/tos' - contact: - name: Developer Relations - url: 'https://developer.sailpoint.com/discuss/api-help' - license: - name: MIT - url: 'https://opensource.org/licenses/MIT' - version: 3.0.0 -servers: - - url: 'https://{tenant}.api.identitynow.com/v3' - description: This is the production API server. - variables: - tenant: - default: sailpoint - description: 'This is the name of your tenant, typically your company''s name.' -tags: - - name: Access Request Approvals - description: | - Use this API to implement and customize access request approval functionality. - With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. - This enables more qualified users to review access requests and the others to spend their time on other tasks. - - In IdentityNow, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. - For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. - For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. - If the administrator designates a governance group as the required approver, any governance group member can approve the requests. - - When a user submits an access request, IdentityNow sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. - - In Approvals in IdentityNow, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. - If the required approver approves the request and is the only reviewer required, IdentityNow grants or revokes access, based on the request. - If multiple reviewers are required, IdentityNow sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. - The required approver can then view any completed access requests under the Reviewed tab. - - Refer to the following link for more information about access request approvals: - externalDocs: - description: Learn more about access request approvals - url: 'https://documentation.sailpoint.com/saas/help/requests/index.html' - - name: Access Requests - description: | - Use this API to implement and customize access request functionality. - With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. - This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. - - IdentityNow's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. - - In the Request Center in IdentityNow, users can view available applications, roles, and entitlements and request access to them. - If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. - - Users can use My Requests to track and/or cancel the requests. - - In My Team on the IdentityNow Home, managers can submit requests to revoke their team members' access. - They can use the My Requests tab under Request Center to track and/or cancel the requests. - - Refer to the following link for more information about access requests: - externalDocs: - description: Learn more about access requests - url: 'https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html' - - name: Accounts - description: | - Use this API to implement and customize account functionality. - With this functionality in place, administrators can manage users' access across sources in IdentityNow. - - In IdentityNow, an account refers to a user's account on a supported source. - This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. IdentityNow loads accounts through the creation of sources in IdentityNow. - - Administrators can correlate users' identities with the users' accounts on the different sources they use. - This allows IdentityNow to govern the access of identities and all their correlated accounts securely and cohesively. - - To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. - - To view and edit source account statuses for an identity in IdentityNow, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. - Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. - - Accounts can have the following statuses: - - - Enabled: The account is enabled. The user can access it. - - - Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in IdentityNow. This can occur when an administrator disables the account or when the user's lifecycle state changes. - - - Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. - - - Pending: The account is currently updating. This status typically lasts seconds. - - Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. - - Refer to the following link for more information about accounts: - externalDocs: - description: Learn more about accounts - url: 'https://documentation.sailpoint.com/saas/help/common/users/user_access.html' - - name: Account Activities - description: | - Use this API to implement account activity tracking functionality. - With this functionality in place, users can track source account activity in IdentityNow, which greatly improves traceability in the system. - - An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. - In IdentityNow's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. - - Account activity includes most actions IdentityNow completes on source accounts. Users can search in IdentityNow for the following account action types: - - - Access Request: These include any access requests the source account is involved in. - - - Account Attribute Updates: These include updates to a single attribute on an account on a source. - - - Account State Update: These include locking or unlocking actions on an account on a source. - - - Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. - - - Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. - IdentityNow replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. - - - Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. - When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. - Account Activity does not include attribute updates that occur as a result of aggregation. - - - Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. - These also include refreshes that occur whenever IdentityNow assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. - - - Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. - - - Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. - - - Password Change: These include password changes on sources. - - Refer to the following link for more information about account activities: - externalDocs: - description: Learn more about account activities - url: 'https://documentation.sailpoint.com/saas/help/search/index.html' - - name: Certifications - description: | - Use this API to implement certification functionality. - With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. - Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. - - A certification refers to IdentityNow's mechanism for reviewing user's access to entitlements (sets of permissions) and approving or removing that access. - These serve as a way of showing that a user's access has been reviewed and approved. - Multiple certifications by different reviewers are often required to approve a user's access. - A set of multiple certifications is called a certification campaign. - - For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by his or her manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. - Once this certification has been completed, IdentityNow would provision all the access the user needs, nothing more. - - Organization administrators or certification administrators can designate other IdentityNow users as certification reviewers. - Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. - - When a certification campaign is in progress,certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. - Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. - - Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. - Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. - - Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. - In this situation, the certification campaign completes once all the remediation requests are completed. - - Refer to the following link for more information about certifications: - externalDocs: - description: Learn more about certifications here - url: 'https://documentation.sailpoint.com/saas/user-help/certifications.html' - - name: Certification Summaries - - name: Lifecycle States - description: | - Use this API to implement and customize lifecycle state functionality. - With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. - - A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with IdentityNow: 'Active' and 'Inactive.' - When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. - The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. - This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. - - Administrators can create a variety of custom lifecycle states. See [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. - - Administrators must define the criteria for being in each lifecycle state, and they must define how IdentityNow manages users' access to apps and sources for each lifecycle state. - - In IdentityNow, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. - - In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: - - - Enable/disable the lifecycle state for the identity profile. - - - Enable/disable source accounts for the identity profile's lifecycle state. - - - Add existing access profiles to grant to the identity profiles in that lifecycle state. - - - Create a new access profile to grant to the identity profile in that lifecycle state. - - Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. - To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. - For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. - - During scheduled refreshes, IdentityNow evaluates lifFecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. - If the identities are missing access, IdentityNow provisions that access. - - Administrators can also use the 'Provisioning' tab to configure email notifications for IdentityNow to send whenever an identity with that identity profile has a lifecycle state change. - See [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. - - An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' - See [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. - - Refer to the following link for more information about lifecycle states: - externalDocs: - description: Learn more about lifecycle states - url: 'https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html' - - name: Identity Profiles - description: | - Use this API to implement identity profile functionality. - With this functionality in place, administrators can view identity profiles and their configurations. - - Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. - - In IdentityNow, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. - This list shows some details about each identity profile, along with its status. - They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. - - Refer to the following link for more information about identity profiles: - externalDocs: - description: Learn more about identity profiles - url: 'https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html' - - name: Non-Employee Lifecycle Management - description: | - Use this API to implement non-employee lifecycle management functionality. - With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. - This allows organizations to provide secure access to non-employees and control that access. - - The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. - Organizations can track non-employees' access and activity in IdentityNow by creating and maintaining non-employee sources. - Organizations can have a maximum of 50 non-employee sources. - - By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: - - - SailPoint is not responsible for storing sensitive data. - You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in IdentityNow. - - - You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. - - To manage non-employees in IdentityNow, administrators must create a non-employee source and add accounts to the source. - - To create a non-employee source in IdentityNow, administrators must use the Admin panel to go to Connections > Sources. - They must then specify 'Non-Employee' in the 'Source Type' field. - See [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. - - To add accounts to a non-employee source in IdentityNow, administrators can select the non-employee source and add the accounts. - They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. - - Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. - To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. - See [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. - - Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. - - Refer to the following link for more information about non-employee lifecycle management: - externalDocs: - description: Learn more about non-employee lifecycle management - url: 'https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html' - - name: OAuth Clients - description: | - Use this API to implement OAuth client functionality. - With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the IdentityNow REST API. - See [Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information about OAuth and how it works with the IdentityNow REST API. - - name: Password Management - description: | - Use this API to implement password management functionality. - With this functionality in place, users can manage their identity passwords for all their applications. - - In IdentityNow, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. - Password Manager lists the user's identity's applications, possibly grouped to share passwords. - Users can then select 'Change Password' to update their passwords. - - Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. - Password Manager may list the applications and sources in the following groups: - - - Password Group: This refers to a group of applications that share a password. - For example, a user can use the same password for Google Drive, Google Mail, and YouTube. - Updating the password for the password group updates the password for all its included applications. - - - Multi-Application Source: This refers to a source with multiple applications that share a password. - For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. - Updating the password for the multi-application source updates the password for all its included applications. - - - Applications: These are applications that do not share passwords with other applications. - - An organization may require some authentication for users to update their passwords. - Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. - - Refer to the following link for more information about password management: - externalDocs: - description: Learn more about password management - url: 'https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html' - - name: Personal Access Tokens - description: | - Use this API to implement personal access token (PAT) functionality. - With this functionality in place, users can use PATs as an alternative to passwords for authentication in IdentityNow. - - PATs embed user information into the client ID and secret. - This replaces the API clients' need to store and provide a username and password to establish a connection, improving IdentityNow organizations' integration security. - - In IdentityNow, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. - They must then provide a description about the token's purpose. - They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. - - Refer to the following link for more information about PATs: - externalDocs: - description: Learn more about PATs - url: 'https://documentation.sailpoint.com/saas/help/common/generate_tokens.html' - - name: Public Identities - description: | - Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/idn/api/v3/public-identities-config) to enable non-administrators to view identities' publicly visible attributes. - With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. - This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. - - name: Public Identities Config - description: | - Use this API to implement public identity configuration functionality. - With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. - This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. - - By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. - However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. - Administrators can use this API to make those necessary identity attributes public to non-administrators. - - For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. - If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/idn/api/v3/update-public-identity-config) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. - - name: Requestable Objects - description: | - Use this API to implement requestable object functionality. - With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/idn/api/v3/access-requests), along with their statuses. - This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. - - name: Saved Search - - name: Scheduled Search - - name: Search - - name: Service Desk Integration - description: | - Use this API to build an integration between IdentityNow and a service desk ITSM (IT service management) solution. - Once an administrator builds this integration between IdentityNow and a service desk, users can use IdentityNow to raise and track tickets that are synchronized between IdentityNow and the service desk. - - In IdentityNow, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' - - To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. - See [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in IdentityNow. - - Administrators can create various service desk integrations, all with their own nuances. - The following service desk integrations are available: - - - [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud/introduction.html) - - - [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server/introduction.html) - - - [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) - - - [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) - - - [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) - - - [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) - - - [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) - - name: Sources - - name: Transforms - description: | - The purpose of this API is to expose functionality for the manipulation of Transform objects. - Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having - to write code. These endpoints don't require API calls to other resources, audit service is used for keeping track - of which users have made changes to the Transforms. - externalDocs: - description: Learn more about Building Transforms - url: 'https://developer.sailpoint.com/docs/transforms/building_transforms/building_transforms.html' - - name: Work Items - description: | - Use this API to implement work item functionality. - With this functionality in place, users can manage their work items (tasks). - - Work items refer to the tasks users see in IdentityNow's Task Manager. - They can see the pending work items they need to complete, as well as the work items they have already completed. - Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. - For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. - Once the user completes the work item, the work item will be listed with his or her other completed work items. - - To complete work items, users can use their dashboards and select the 'My Tasks' widget. - The widget will list any work items they need to complete, and they can select the work item from the list to review its details. - When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. - - Refer to the following link for more information about work items, like the different types of work items users may need to complete: - externalDocs: - description: Learn more about work items - url: 'https://documentation.sailpoint.com/saas/user-help/task_manager.html' -paths: - /access-requests: - post: - operationId: createAccessRequest - summary: Submit an Access Request - tags: - - Access Requests - description: | - This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. - - Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request - has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error - if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. - It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can - be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also - use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting - an access request to ensure you are not requesting access that is already granted. - - There are two types of access request: - - __GRANT_ACCESS__ - * Can be requested for multiple identities in a single request. - * Supports self request and request on behalf of other users, see '/beta/access-request-config' endpoint for request configuration options. - * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. - * Roles, Access Profiles and Entitlements can be requested. - * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. - - __REVOKE_ACCESS__ - * Can only be requested for a single identity at a time. - * Does not support self request. Only manager can request to revoke access for their directly managed employees. - * If removeDate is specified, then the access will be removed on that date and time. - * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. - * Roles and Access Profiles can be requested for revocation. Revoke request for entitlements are not supported currently. - - NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. - - A token with API authority cannot be used to call this endpoint. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - requestedFor: - description: 'A list of Identity IDs for whom the Access is requested. If it''s a Revoke request, there can only be one Identity ID.' - type: array - items: - type: string - example: 2c918084660f45d6016617daa9210584 - requestType: - type: string - enum: - - GRANT_ACCESS - - REVOKE_ACCESS - description: Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. Currently REVOKE_ACCESS is not supported for entitlements. - example: GRANT_ACCESS - requestedItems: - type: array - items: - type: object - properties: - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of the item being requested. - example: ACCESS_PROFILE - id: - type: string - description: 'ID of Role, Access Profile or Entitlement being requested.' - example: 2c9180835d2e5168015d32f890ca1581 - comment: - type: string - description: | - Comment provided by requester. - * Comment is required when the request is of type Revoke Access. - example: Requesting access profile for John Doe - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - removeDate: - type: string - description: | - The date the role or access profile is no longer assigned to the specified identity. - * Specify a date in the future. - * The current SLA for the deprovisioning is 24 hours. - * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. - * Currently it is not supported for entitlements. - format: date-time - example: '2020-07-11T21:23:15.000Z' - required: - - id - - type - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - required: - - requestedFor - - requestedItems - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /access-requests/cancel: - post: - operationId: cancelAccessRequest - tags: - - Access Requests - summary: Cancel Access Request - description: |- - This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. - Any token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it. - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Request body payload for cancel access request endpoint. - required: - - accountActivityId - - comment - properties: - accountActivityId: - type: string - description: ID of the account activity object corresponding to the access request. - example: 2c9180835d2e5168015d32f890ca1581 - comment: - type: string - description: Reason for cancelling the pending access request. - example: I requested this role by mistake. - example: - accountActivityId: 2c91808568c529c60168cca6f90c1313 - comment: I requested this role by mistake. - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /access-request-config: - get: - operationId: getAccessRequestConfig - summary: Get Access Request Configuration - tags: - - Access Requests - description: This endpoint returns the current access-request configuration. - responses: - '200': - description: Access Request Configuration Details. - content: - application/json: - schema: - type: object - properties: - approvalsMustBeExternal: - type: boolean - description: 'If true, then approvals must be processed by external system.' - example: true - autoApprovalEnabled: - type: boolean - description: 'If true and requester and reviewer are the same, then automatically approve the approval.' - example: true - requestOnBehalfOfConfig: - description: Request On Behalf Of Configuration. - type: object - properties: - allowRequestOnBehalfOfAnyoneByAnyone: - type: boolean - description: If anyone can request access for anyone. - example: true - allowRequestOnBehalfOfEmployeeByManager: - type: boolean - description: If a manager can request access for his/her direct reports. - example: true - approvalReminderAndEscalationConfig: - description: Approval Reminder and Escalation Configuration. - type: object - properties: - daysUntilEscalation: - type: integer - description: 'Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.' - format: int32 - example: 0 - daysBetweenReminders: - type: integer - description: Number of days to wait between reminder notifications. - format: int32 - example: 0 - maxReminders: - type: integer - description: Maximum number of reminder notification to send to the reviewer before approval escalation. - format: int32 - example: 0 - fallbackApproverRef: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlementRequestConfig: - description: Entitlement Request Configuration. - type: object - properties: - allowEntitlementRequest: - type: boolean - description: Flag for allowing entitlement request. - example: true - requestCommentsRequired: - type: boolean - description: Flag for requiring comments while submitting an entitlement request. - default: false - example: false - deniedCommentsRequired: - type: boolean - description: Flag for requiring comments while rejecting an entitlement request. - default: false - example: false - grantRequestApprovalSchemes: - type: string - description: | - Approval schemes for granting entitlement request. This can be empty if no approval is needed. - Multiple schemes must be comma-separated. The valid schemes are "sourceOwner", "manager" and "workgroup:{id}". - Multiple workgroups (governance groups) can be used. - default: sourceOwner - example: 'sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: updateAccessRequestConfig - summary: Update Access Request Configuration - tags: - - Access Requests - description: |- - This endpoint replaces the current access-request configuration. - A token with ORG_ADMIN authority is required to call this API. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - approvalsMustBeExternal: - type: boolean - description: 'If true, then approvals must be processed by external system.' - example: true - autoApprovalEnabled: - type: boolean - description: 'If true and requester and reviewer are the same, then automatically approve the approval.' - example: true - requestOnBehalfOfConfig: - description: Request On Behalf Of Configuration. - type: object - properties: - allowRequestOnBehalfOfAnyoneByAnyone: - type: boolean - description: If anyone can request access for anyone. - example: true - allowRequestOnBehalfOfEmployeeByManager: - type: boolean - description: If a manager can request access for his/her direct reports. - example: true - approvalReminderAndEscalationConfig: - description: Approval Reminder and Escalation Configuration. - type: object - properties: - daysUntilEscalation: - type: integer - description: 'Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.' - format: int32 - example: 0 - daysBetweenReminders: - type: integer - description: Number of days to wait between reminder notifications. - format: int32 - example: 0 - maxReminders: - type: integer - description: Maximum number of reminder notification to send to the reviewer before approval escalation. - format: int32 - example: 0 - fallbackApproverRef: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlementRequestConfig: - description: Entitlement Request Configuration. - type: object - properties: - allowEntitlementRequest: - type: boolean - description: Flag for allowing entitlement request. - example: true - requestCommentsRequired: - type: boolean - description: Flag for requiring comments while submitting an entitlement request. - default: false - example: false - deniedCommentsRequired: - type: boolean - description: Flag for requiring comments while rejecting an entitlement request. - default: false - example: false - grantRequestApprovalSchemes: - type: string - description: | - Approval schemes for granting entitlement request. This can be empty if no approval is needed. - Multiple schemes must be comma-separated. The valid schemes are "sourceOwner", "manager" and "workgroup:{id}". - Multiple workgroups (governance groups) can be used. - default: sourceOwner - example: 'sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584' - responses: - '200': - description: Access Request Configuration Details. - content: - application/json: - schema: - type: object - properties: - approvalsMustBeExternal: - type: boolean - description: 'If true, then approvals must be processed by external system.' - example: true - autoApprovalEnabled: - type: boolean - description: 'If true and requester and reviewer are the same, then automatically approve the approval.' - example: true - requestOnBehalfOfConfig: - description: Request On Behalf Of Configuration. - type: object - properties: - allowRequestOnBehalfOfAnyoneByAnyone: - type: boolean - description: If anyone can request access for anyone. - example: true - allowRequestOnBehalfOfEmployeeByManager: - type: boolean - description: If a manager can request access for his/her direct reports. - example: true - approvalReminderAndEscalationConfig: - description: Approval Reminder and Escalation Configuration. - type: object - properties: - daysUntilEscalation: - type: integer - description: 'Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.' - format: int32 - example: 0 - daysBetweenReminders: - type: integer - description: Number of days to wait between reminder notifications. - format: int32 - example: 0 - maxReminders: - type: integer - description: Maximum number of reminder notification to send to the reviewer before approval escalation. - format: int32 - example: 0 - fallbackApproverRef: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlementRequestConfig: - description: Entitlement Request Configuration. - type: object - properties: - allowEntitlementRequest: - type: boolean - description: Flag for allowing entitlement request. - example: true - requestCommentsRequired: - type: boolean - description: Flag for requiring comments while submitting an entitlement request. - default: false - example: false - deniedCommentsRequired: - type: boolean - description: Flag for requiring comments while rejecting an entitlement request. - default: false - example: false - grantRequestApprovalSchemes: - type: string - description: | - Approval schemes for granting entitlement request. This can be empty if no approval is needed. - Multiple schemes must be comma-separated. The valid schemes are "sourceOwner", "manager" and "workgroup:{id}". - Multiple workgroups (governance groups) can be used. - default: sourceOwner - example: 'sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /access-request-status: - get: - operationId: listAccessRequestStatus - tags: - - Access Requests - summary: Access Request Status - description: |- - The Access Request Status API returns a list of access request statuses based on the specified query parameters. - Any token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users. - parameters: - - in: query - name: requested-for - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - - in: query - name: requested-by - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - - in: query - name: regarding-identity - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - required: false - - in: query - name: count - description: If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - required: false - schema: - type: boolean - default: false - example: false - - in: query - name: limit - description: Max number of results to return. - required: false - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - example: 100 - - in: query - name: offset - description: Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - required: false - schema: - type: integer - format: int32 - minimum: 0 - example: 10 - - in: query - name: filters - schema: - type: string - example: accountActivityItemId eq "2c918086771c86df0177401efcdf54c0" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **accountActivityItemId**: *eq, in* - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified, accountActivityItemId** - example: created - responses: - '200': - description: List of requested item status. - content: - application/json: - schema: - type: array - items: - type: object - properties: - name: - type: string - description: Human-readable display name of the item being requested. - example: AccessProfile1 - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: Type of requested object. - example: ACCESS_PROFILE - cancelledRequestDetails: - type: object - properties: - comment: - type: string - description: Comment made by the owner when cancelling the associated request. - example: Nisl quis ipsum quam quisque condimentum nunc ut dolor nunc. - owner: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - modified: - type: string - format: date-time - description: Date comment was added by the owner when cancelling the associated request - example: '2019-12-20T09:17:12.192Z' - description: Provides additional details for a request that has been cancelled. - errorMessages: - type: array - items: - type: array - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - description: 'List of list of localized error messages, if any, encountered during the approval/provisioning process.' - state: - type: string - enum: - - EXECUTING - - REQUEST_COMPLETED - - CANCELLED - - TERMINATED - - PROVISIONING_VERIFICATION_PENDING - - REJECTED - - PROVISIONING_FAILED - - NOT_ALL_ITEMS_PROVISIONED - - ERROR - description: |- - Indicates the state of an access request: - * EXECUTING: The request is executing, which indicates the system is doing some processing. - * REQUEST_COMPLETED: Indicates the request has been completed. - * CANCELLED: The request was cancelled with no user input. - * TERMINATED: The request has been terminated before it was able to complete. - * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. - * REJECTED: The request was rejected. - * PROVISIONING_FAILED: The request has failed to complete. - * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. - * ERROR: An error occurred during request processing. - example: EXECUTING - approvalDetails: - type: array - items: - type: object - properties: - forwarded: - type: boolean - description: True if the request for this item was forwarded from one owner to another. - originalOwner: - description: 'Base identity/workgroup reference object representing the original owner, if forwarded.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - currentOwner: - description: Base reference of approver that will make decision. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - reviewedBy: - description: The identity who has reviewed the approval. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - modified: - type: string - format: date-time - description: Time at which item was modified. - example: '2019-08-23T18:52:57.398Z' - status: - type: string - enum: - - PENDING - - APPROVED - - REJECTED - - EXPIRED - - CANCELLED - - ARCHIVED - description: |- - Indicates the state of the request processing for this item: - * PENDING: The request for this item is awaiting processing. - * APPROVED: The request for this item has been approved. - * REJECTED: The request for this item was rejected. - * EXPIRED: The request for this item expired with no action taken. - * CANCELLED: The request for this item was cancelled with no user action. - * ARCHIVED: The request for this item has been archived after completion. - example: PENDING - scheme: - type: string - enum: - - APP_OWNER - - SOURCE_OWNER - - MANAGER - - ROLE_OWNER - - ACCESS_PROFILE_OWNER - - GOVERNANCE_GROUP - description: Describes the individual or group that is responsible for an approval step. - errorMessages: - type: array - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - description: 'If the request failed, includes any error messages that were generated.' - comment: - type: string - description: 'Comment, if any, provided by the approver.' - removeDate: - type: string - description: The date the role or access profile is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - description: Approval details for each item. - manualWorkItemDetails: - type: array - items: - type: object - properties: - forwarded: - type: boolean - description: True if the request for this item was forwarded from one owner to another. - example: true - originalOwner: - description: 'Base identity/workgroup reference object representing the original owner, if forwarded.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - currentOwner: - description: Base reference of approver that will make decision. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - modified: - type: string - format: date-time - description: Time at which item was modified. - example: '2019-08-23T18:52:57.398Z' - status: - type: string - enum: - - PENDING - - APPROVED - - REJECTED - - EXPIRED - - CANCELLED - - ARCHIVED - description: |- - Indicates the state of the request processing for this item: - * PENDING: The request for this item is awaiting processing. - * APPROVED: The request for this item has been approved. - * REJECTED: The request for this item was rejected. - * EXPIRED: The request for this item expired with no action taken. - * CANCELLED: The request for this item was cancelled with no user action. - * ARCHIVED: The request for this item has been archived after completion. - example: PENDING - description: Manual work items created for provisioning the item. - accountActivityItemId: - type: string - description: Id of associated account activity item. - example: 2c9180926cbfbddd016cbfc7c3b10010 - requestType: - type: string - enum: - - GRANT_ACCESS - - REVOKE_ACCESS - description: Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. Currently REVOKE_ACCESS is not supported for entitlements. - example: GRANT_ACCESS - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - requester: - description: The identity that requested the item. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - requestedFor: - description: The identity for whom the Access Request Status is requested for. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - requesterComment: - description: The requester's comment. - type: object - properties: - comment: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - author: - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the author - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - created: - type: string - format: date-time - description: Date and time comment was created - example: '2017-07-11T18:45:37.098Z' - sodViolationContext: - description: The details of the SOD violations for the associated approval. - type: object - properties: - state: - type: string - enum: - - SUCCESS - - ERROR - description: The status of SOD violation check - example: SUCCESS - uuid: - description: The id of the Violation check event - type: string - example: f73d16e9-a038-46c5-b217-1246e15fdbdd - violationCheckResult: - description: The inner object representing the completed SOD Violation check - type: object - properties: - message: - description: 'If the request failed, includes any error message that was generated.' - example: - - locale: en-US - localeOrigin: DEFAULT - text: An error has occurred during the SOD violation check - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - clientMetadata: - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - violationContexts: - type: array - items: - description: The contextual information of the violated criteria - type: object - properties: - policy: - description: Reference to the Policy that is being violated. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - conflictingAccessCriteria: - type: object - description: The object which contains the left and right hand side of the entitlements that got violated according to the policy. - properties: - leftCriteria: - type: object - properties: - criteriaList: - type: array - items: - description: Details of the Entitlement criteria - type: object - properties: - existing: - type: boolean - example: true - description: If the entitlement already belonged to the user or not. - type: - example: ENTITLEMENT - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Entitlement ID - example: 2c918085771e9d3301773b3cb66f6398 - name: - type: string - description: Entitlement name - example: My HR Entitlement - rightCriteria: - type: object - properties: - criteriaList: - type: array - items: - description: Details of the Entitlement criteria - type: object - properties: - existing: - type: boolean - example: true - description: If the entitlement already belonged to the user or not. - type: - example: ENTITLEMENT - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Entitlement ID - example: 2c918085771e9d3301773b3cb66f6398 - name: - type: string - description: Entitlement name - example: My HR Entitlement - violatedPolicies: - type: array - description: A list of the Policies that were violated - items: - description: Reference to the policy that was violated - example: - - type: SOD_POLICY - id: 69129440-422d-4a23-aadd-35c828d5bfda - name: HR Policy - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - provisioningDetails: - type: object - properties: - orderedSubPhaseReferences: - type: string - description: 'Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain "manualWorkItemDetails" which indicate that there is further information in that object for this phase.' - example: manualWorkItemDetails - description: Provides additional details about provisioning for this request. - preApprovalTriggerDetails: - type: object - properties: - comment: - type: string - description: Comment left for the pre-approval decision - example: Access is Approved - reviewer: - type: string - description: The reviewer of the pre-approval decision - example: John Doe - decision: - type: string - enum: - - APPROVED - - REJECTED - description: The decision of the pre-approval trigger - example: APPROVED - description: Provides additional details about the pre-approval trigger for this request. - accessRequestPhases: - type: array - items: - type: object - properties: - started: - type: string - description: The time that this phase started. - format: date-time - example: '2020-07-11T00:00:00Z' - finished: - type: string - description: The time that this phase finished. - format: date-time - example: '2020-07-12T00:00:00Z' - name: - type: string - description: The name of this phase. - example: APPROVAL_PHASE - state: - type: string - enum: - - PENDING - - EXECUTING - - COMPLETED - - CANCELLED - description: The state of this phase. - example: COMPLETED - result: - type: string - enum: - - SUCCESSFUL - - FAILED - description: The state of this phase. - example: SUCCESSFUL - phaseReference: - type: string - description: 'A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items.' - example: approvalDetails - description: Provides additional details about this access request phase. - description: 'A list of Phases that the Access Request has gone through in order, to help determine the status of the request.' - description: - type: string - description: Description associated to the requested object. - example: This is the Engineering role that engineers are granted. - removeDate: - type: string - format: date-time - description: When the role access is scheduled for removal. - example: '2019-10-23T00:00:00.000Z' - cancelable: - type: boolean - description: True if the request can be canceled. - example: true - accessRequestId: - type: string - format: uuid - description: This is the account activity id. - example: ef38f94347e94562b5bb8424a56397d8 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /access-request-approvals/pending: - get: - operationId: listPendingApprovals - summary: Pending Access Request Approvals List - tags: - - Access Request Approvals - description: This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. - parameters: - - in: query - name: owner-id - schema: - type: string - description: |- - If present, the value returns only pending approvals for the specified identity. - * ORG_ADMIN users can call this with any identity ID value. - * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. - * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - example: 2c91808568c529c60168cca6f90c1313 - required: false - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **requestedFor.id**: *eq, in* - - **modified**: *gt, lt, ge, le* - example: id eq "2c91808568c529c60168cca6f90c1313" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - example: modified - responses: - '200': - description: List of Pending Approvals. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The approval id. - example: id12345 - name: - type: string - description: The name of the approval. - example: aName - created: - type: string - format: date-time - description: When the approval was created. - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: When the approval was modified last time. - example: '2018-07-25T20:22:28.104Z' - requestCreated: - type: string - format: date-time - description: When the access-request was created. - example: '2017-07-11T18:45:35.098Z' - requestType: - description: If the access-request was for granting or revoking access. - type: string - enum: - - GRANT_ACCESS - - REVOKE_ACCESS - example: GRANT_ACCESS - requester: - description: The identity that requested the item. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - requestedFor: - description: The identity for whom the item is requested for. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - owner: - description: The owner or approver of the approval. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - requestedObject: - description: The requested access item. - type: object - properties: - id: - type: string - description: Id of the object. - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the object. - example: Applied Research Access - description: - type: string - description: Description of the object. - example: 'Access to research information, lab results, and schematics' - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: Type of the object. - example: ROLE - requesterComment: - description: The requester's comment. - type: object - properties: - comment: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - author: - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the author - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - created: - type: string - format: date-time - description: Date and time comment was created - example: '2017-07-11T18:45:37.098Z' - previousReviewersComments: - type: array - items: - type: object - properties: - comment: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - author: - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the author - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - created: - type: string - format: date-time - description: Date and time comment was created - example: '2017-07-11T18:45:37.098Z' - description: The history of the previous reviewers comments. - forwardHistory: - type: array - items: - type: object - properties: - oldApproverName: - type: string - description: Display name of approver that forwarded the approval. - example: frank.mir - newApproverName: - type: string - description: Display name of approver to whom the approval was forwarded. - example: al.volta - comment: - type: string - description: Comment made by old approver when forwarding. - example: Fusce id orci vel consectetur amet ipsum quam. - modified: - type: string - format: date-time - description: Time at which approval was forwarded. - example: '2019-08-23T18:52:57.398Z' - description: The history of approval forward action. - commentRequiredWhenRejected: - type: boolean - description: When true the rejector has to provide comments when rejecting - example: true - actionInProcess: - description: 'Action that is performed on this approval, and system has not finished performing that action yet.' - type: string - enum: - - APPROVED - - REJECTED - - FORWARDED - example: APPROVED - removeDate: - type: string - description: The date the role or access profile is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - removeDateUpdateRequested: - type: boolean - description: 'If true, then the request is to change the remove date or sunset date.' - example: true - currentRemoveDate: - type: string - description: The remove date or sunset date that was assigned at the time of the request. - format: date-time - example: '2020-07-11T00:00:00Z' - sodViolationContext: - description: The details of the SOD violations for the associated approval. - type: object - properties: - state: - type: string - enum: - - SUCCESS - - ERROR - description: The status of SOD violation check - example: SUCCESS - uuid: - description: The id of the Violation check event - type: string - example: f73d16e9-a038-46c5-b217-1246e15fdbdd - violationCheckResult: - description: The inner object representing the completed SOD Violation check - type: object - properties: - message: - description: 'If the request failed, includes any error message that was generated.' - example: - - locale: en-US - localeOrigin: DEFAULT - text: An error has occurred during the SOD violation check - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - clientMetadata: - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - violationContexts: - type: array - items: - description: The contextual information of the violated criteria - type: object - properties: - policy: - description: Reference to the Policy that is being violated. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - conflictingAccessCriteria: - type: object - description: The object which contains the left and right hand side of the entitlements that got violated according to the policy. - properties: - leftCriteria: - type: object - properties: - criteriaList: - type: array - items: - description: Details of the Entitlement criteria - type: object - properties: - existing: - type: boolean - example: true - description: If the entitlement already belonged to the user or not. - type: - example: ENTITLEMENT - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Entitlement ID - example: 2c918085771e9d3301773b3cb66f6398 - name: - type: string - description: Entitlement name - example: My HR Entitlement - rightCriteria: - type: object - properties: - criteriaList: - type: array - items: - description: Details of the Entitlement criteria - type: object - properties: - existing: - type: boolean - example: true - description: If the entitlement already belonged to the user or not. - type: - example: ENTITLEMENT - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Entitlement ID - example: 2c918085771e9d3301773b3cb66f6398 - name: - type: string - description: Entitlement name - example: My HR Entitlement - violatedPolicies: - type: array - description: A list of the Policies that were violated - items: - description: Reference to the policy that was violated - example: - - type: SOD_POLICY - id: 69129440-422d-4a23-aadd-35c828d5bfda - name: HR Policy - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /access-request-approvals/completed: - get: - operationId: listCompletedApprovals - summary: Completed Access Request Approvals List - tags: - - Access Request Approvals - description: This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - parameters: - - in: query - name: owner-id - required: false - schema: - type: string - description: |- - If present, the value returns only completed approvals for the specified identity. - * ORG_ADMIN users can call this with any identity ID value. - * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. - * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - example: 2c91808568c529c60168cca6f90c1313 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **requestedFor.id**: *eq, in* - - **modified**: *gt, lt, ge, le* - example: id eq "2c91808568c529c60168cca6f90c1313" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - example: modified - responses: - '200': - description: List of Completed Approvals. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The approval id. - example: id12345 - name: - type: string - description: The name of the approval. - example: aName - created: - type: string - format: date-time - description: When the approval was created. - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: When the approval was modified last time. - example: '2018-07-25T20:22:28.104Z' - requestCreated: - type: string - format: date-time - description: When the access-request was created. - example: '2017-07-11T18:45:35.098Z' - requestType: - description: If the access-request was for granting or revoking access. - type: string - enum: - - GRANT_ACCESS - - REVOKE_ACCESS - example: GRANT_ACCESS - requester: - description: The identity that requested the item. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - requestedFor: - description: The identity for whom the item is requested for. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - reviewedBy: - description: The identity who has reviewed the approval. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - owner: - description: The owner or approver of the approval. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - requestedObject: - description: The requested access item. - type: object - properties: - id: - type: string - description: Id of the object. - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the object. - example: Applied Research Access - description: - type: string - description: Description of the object. - example: 'Access to research information, lab results, and schematics' - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: Type of the object. - example: ROLE - requesterComment: - description: The requester's comment. - type: object - properties: - comment: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - author: - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the author - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - created: - type: string - format: date-time - description: Date and time comment was created - example: '2017-07-11T18:45:37.098Z' - reviewerComment: - description: The approval's reviewer's comment. - type: object - properties: - comment: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - author: - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the author - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - created: - type: string - format: date-time - description: Date and time comment was created - example: '2017-07-11T18:45:37.098Z' - previousReviewersComments: - type: array - items: - type: object - properties: - comment: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - author: - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the author - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - created: - type: string - format: date-time - description: Date and time comment was created - example: '2017-07-11T18:45:37.098Z' - description: The history of the previous reviewers comments. - forwardHistory: - type: array - items: - type: object - properties: - oldApproverName: - type: string - description: Display name of approver that forwarded the approval. - example: frank.mir - newApproverName: - type: string - description: Display name of approver to whom the approval was forwarded. - example: al.volta - comment: - type: string - description: Comment made by old approver when forwarding. - example: Fusce id orci vel consectetur amet ipsum quam. - modified: - type: string - format: date-time - description: Time at which approval was forwarded. - example: '2019-08-23T18:52:57.398Z' - description: The history of approval forward action. - commentRequiredWhenRejected: - type: boolean - description: When true the rejector has to provide comments when rejecting - example: true - state: - description: The final state of the approval - type: string - enum: - - APPROVED - - REJECTED - example: APPROVED - removeDate: - type: string - description: The date the role or access profile is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - removeDateUpdateRequested: - type: boolean - description: 'If true, then the request was to change the remove date or sunset date.' - example: true - currentRemoveDate: - type: string - description: The remove date or sunset date that was assigned at the time of the request. - format: date-time - example: '2020-07-11T00:00:00Z' - sodViolationContext: - description: The details of the SOD violations for the associated approval. - type: object - properties: - state: - type: string - enum: - - SUCCESS - - ERROR - description: The status of SOD violation check - example: SUCCESS - uuid: - description: The id of the Violation check event - type: string - example: f73d16e9-a038-46c5-b217-1246e15fdbdd - violationCheckResult: - description: The inner object representing the completed SOD Violation check - type: object - properties: - message: - description: 'If the request failed, includes any error message that was generated.' - example: - - locale: en-US - localeOrigin: DEFAULT - text: An error has occurred during the SOD violation check - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - clientMetadata: - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - violationContexts: - type: array - items: - description: The contextual information of the violated criteria - type: object - properties: - policy: - description: Reference to the Policy that is being violated. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - conflictingAccessCriteria: - type: object - description: The object which contains the left and right hand side of the entitlements that got violated according to the policy. - properties: - leftCriteria: - type: object - properties: - criteriaList: - type: array - items: - description: Details of the Entitlement criteria - type: object - properties: - existing: - type: boolean - example: true - description: If the entitlement already belonged to the user or not. - type: - example: ENTITLEMENT - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Entitlement ID - example: 2c918085771e9d3301773b3cb66f6398 - name: - type: string - description: Entitlement name - example: My HR Entitlement - rightCriteria: - type: object - properties: - criteriaList: - type: array - items: - description: Details of the Entitlement criteria - type: object - properties: - existing: - type: boolean - example: true - description: If the entitlement already belonged to the user or not. - type: - example: ENTITLEMENT - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Entitlement ID - example: 2c918085771e9d3301773b3cb66f6398 - name: - type: string - description: Entitlement name - example: My HR Entitlement - violatedPolicies: - type: array - description: A list of the Policies that were violated - items: - description: Reference to the policy that was violated - example: - - type: SOD_POLICY - id: 69129440-422d-4a23-aadd-35c828d5bfda - name: HR Policy - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/access-request-approvals/{approvalId}/approve': - post: - operationId: approveRequest - summary: Approves an access request approval. - tags: - - Access Request Approvals - description: This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - parameters: - - in: path - name: approvalId - schema: - type: string - required: true - description: The id of the approval. - example: 2c91808b7294bea301729568c68c002e - requestBody: - description: Reviewer's comment. - required: false - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - author: - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the author - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - created: - type: string - format: date-time - description: Date and time comment was created - example: '2017-07-11T18:45:37.098Z' - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/access-request-approvals/{approvalId}/reject': - post: - operationId: rejectRequest - summary: Rejects an access request approval. - tags: - - Access Request Approvals - description: This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - parameters: - - in: path - name: approvalId - schema: - type: string - required: true - description: The id of the approval. - example: 2c91808b7294bea301729568c68c002e - requestBody: - description: Reviewer's comment. - required: false - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - author: - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the author - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - created: - type: string - format: date-time - description: Date and time comment was created - example: '2017-07-11T18:45:37.098Z' - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/access-request-approvals/{approvalId}/forward': - post: - operationId: forwardRequest - summary: Forwards an access request approval. - tags: - - Access Request Approvals - description: This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - parameters: - - in: path - name: approvalId - schema: - type: string - required: true - description: The id of the approval. - example: 2c91808b7294bea301729568c68c002e - requestBody: - description: Information about the forwarded approval. - required: true - content: - application/json: - schema: - type: object - required: - - newOwnerId - - comment - properties: - newOwnerId: - type: string - description: The Id of the new owner - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat - minLength: 1 - maxLength: 255 - comment: - type: string - description: The comment provided by the forwarder - example: 2c91808568c529c60168cca6f90c1313 - minLength: 1 - maxLength: 255 - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /access-request-approvals/approval-summary: - get: - operationId: approvalSummary - summary: Get the number of access-requests-approvals - tags: - - Access Request Approvals - description: 'This endpoint returns the number of pending, approved and rejected access requests approvals. See "owner-id" query parameter below for authorization info.' - parameters: - - in: query - name: owner-id - schema: - type: string - description: |- - The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. - * ORG_ADMIN users can call this with any identity ID value. - * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. - * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - example: 2c91808568c529c60168cca6f90c1313 - - in: query - name: from-date - schema: - type: string - description: From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format - example: 'from-date=2020-03-19T19:59:11Z' - responses: - '200': - description: 'Number of pending, approved, rejected access request approvals.' - content: - application/json: - schema: - type: object - properties: - pending: - type: integer - description: The number of pending access requests approvals. - format: int32 - example: 0 - approved: - type: integer - description: The number of approved access requests approvals. - format: int32 - example: 0 - rejected: - type: integer - description: The number of rejected access requests approvals. - format: int32 - example: 0 - '400': - description: Client Error - Returned if the query parameter is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /accounts: - get: - operationId: listAccounts - tags: - - Accounts - summary: Accounts List - description: |- - This returns a list of accounts. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account-list:read' - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - example: identityId eq "2c9180858082150f0180893dbaf44201" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **identityId**: *eq* - - **name**: *eq, in* - - **nativeIdentity**: *eq, in* - - **sourceId**: *eq, in* - - **uncorrelated**: *eq* - responses: - '200': - description: List of account objects - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - properties: - sourceId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - identityId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - attributes: - type: object - authoritative: - type: boolean - description: - type: string - disabled: - type: boolean - locked: - type: boolean - nativeIdentity: - type: string - systemAccount: - type: boolean - uncorrelated: - type: boolean - uuid: - type: string - manuallyCorrelated: - type: boolean - hasEntitlements: - type: boolean - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createAccount - tags: - - Accounts - summary: Create Account - description: |- - This API submits an account creation task and returns the task ID. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account:create' - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - attributes - properties: - attributes: - description: The schema attribute values for the account - type: object - required: - - sourceId - properties: - sourceId: - type: string - description: Target source to create an account - example: 34bfcbe116c9407464af37acbaf7a4dc - additionalProperties: - type: string - example: - sourceId: 34bfcbe116c9407464af37acbaf7a4dc - city: Austin - displayName: John Doe - userName: jdoe - sAMAccountName: jDoe - mail: john.doe@sailpoint.com - responses: - '202': - description: Async task details - content: - application/json: - schema: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/accounts/{id}': - get: - operationId: getAccount - tags: - - Accounts - summary: Account Details - description: |- - This API returns the details for a single account based on the ID. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account:read' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account ID - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An account object - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - properties: - sourceId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - identityId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - attributes: - type: object - authoritative: - type: boolean - description: - type: string - disabled: - type: boolean - locked: - type: boolean - nativeIdentity: - type: string - systemAccount: - type: boolean - uncorrelated: - type: boolean - uuid: - type: string - manuallyCorrelated: - type: boolean - hasEntitlements: - type: boolean - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: updateAccount - tags: - - Accounts - summary: Update Account - description: |- - Use this API to modify the following fields: - * `identityId` - - * `manuallyCorrelated` - - >**NOTE: All other fields can not be modified.** - - The request must provide a JSONPatch payload. - - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account:update' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account ID - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: 'A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.' - content: - application/json-patch+json: - schema: - type: array - items: - type: object - example: - - op: replace - path: /identityId - value: 2c9180845d1edece015d27a975983e21 - responses: - '202': - description: Accepted. Update request accepted and is in progress. - content: - application/json: - schema: - type: object - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: putAccount - tags: - - Accounts - summary: Update Account - description: |- - This API submits an account update task and returns the task ID. - A token with ORG_ADMIN authority is required to call this API. - >**NOTE: The PUT Account API is designated only for Delimited File sources.** - security: - - oauth2: - - 'idn:account:update' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account ID - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - attributes - properties: - attributes: - description: The schema attribute values for the account - type: object - example: - city: Austin - displayName: John Doe - userName: jdoe - sAMAccountName: jDoe - mail: john.doe@sailpoint.com - responses: - '202': - description: Async task details - content: - application/json: - schema: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteAccount - tags: - - Accounts - summary: Delete Account - description: |- - This API submits an account delete task and returns the task ID. This operation can only be used on Flat File Sources. Any attempt to execute this request on the source of other type will result in an error response with a status code of 400. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account:delete' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account ID - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Async task details - content: - application/json: - schema: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/accounts/{id}/entitlements': - get: - operationId: getAccountEntitlements - tags: - - Accounts - summary: Account Entitlements - description: |- - This API returns entitlements of the account. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account-entitlement:read' - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: path - name: id - schema: - type: string - required: true - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An array of account entitlements - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Entitlement object that represents entitlement - properties: - attribute: - description: Name of the entitlement attribute - type: string - example: authorizationType - value: - description: Raw value of the entitlement - type: string - example: 'CN=Users,dc=sailpoint,dc=com' - description: - description: Entitlment description - type: string - attributes: - description: Entitlement attributes - type: object - sourceSchemaObjectType: - description: Schema objectType on the given application that maps to an Account Group - type: string - example: group - privileged: - description: Determines if this Entitlement is privileged. - type: boolean - cloudGoverned: - description: Determines if this Entitlement is goverened in the cloud. - type: boolean - source: - description: Reference to the source this entitlment belongs to. - example: - - type: SOURCE - id: 2c9180835d191a86015d28455b4b232a - name: HR Active Directory - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/accounts/{id}/reload': - post: - operationId: reloadAccount - tags: - - Accounts - summary: Reload Account - description: |- - This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account:reload' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Async task details - content: - application/json: - schema: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/accounts/{id}/enable': - post: - operationId: enableAccount - tags: - - Accounts - summary: Enable Account - description: |- - This API submits a task to enable account and returns the task ID. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account:enable' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - description: Request used for account enable/disable - type: object - properties: - externalVerificationId: - description: 'If set, an external process validates that the user wants to proceed with this request.' - type: string - example: 3f9180835d2e5168015d32f890ca1581 - forceProvisioning: - description: 'If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing ''true'' for an unlocked account will add and process ''Unlock'' operation by the workflow.' - type: boolean - example: false - responses: - '202': - description: Async task details - content: - application/json: - schema: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/accounts/{id}/disable': - post: - operationId: disableAccount - tags: - - Accounts - summary: Disable Account - description: |- - This API submits a task to disable the account and returns the task ID. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account:disable' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - description: Request used for account enable/disable - type: object - properties: - externalVerificationId: - description: 'If set, an external process validates that the user wants to proceed with this request.' - type: string - example: 3f9180835d2e5168015d32f890ca1581 - forceProvisioning: - description: 'If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing ''true'' for an unlocked account will add and process ''Unlock'' operation by the workflow.' - type: boolean - example: false - responses: - '202': - description: Async task details - content: - application/json: - schema: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/accounts/{id}/unlock': - post: - operationId: unlockAccount - tags: - - Accounts - summary: Unlock Account - description: |- - This API submits a task to unlock an account and returns the task ID. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:account:unlock' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - description: Request used for account unlock - type: object - properties: - externalVerificationId: - description: 'If set, an external process validates that the user wants to proceed with this request.' - type: string - example: 3f9180835d2e5168015d32f890ca1581 - unlockIDNAccount: - description: 'If set, the IDN account is unlocked after the workflow completes.' - type: boolean - example: false - forceProvisioning: - description: 'If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.' - type: boolean - example: false - responses: - '202': - description: Async task details - content: - application/json: - schema: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /account-activities: - get: - operationId: listAccountActivities - tags: - - Account Activities - summary: Get a list of Account Activities - description: This gets a collection of account activities that satisfy the given query parameters. - parameters: - - in: query - name: requested-for - schema: - type: string - description: The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - - in: query - name: requested-by - schema: - type: string - description: The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - - in: query - name: regarding-identity - schema: - type: string - description: The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - required: false - - in: query - name: type - schema: - type: string - description: The type of account activity. - required: false - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - Filtering is supported for the following fields and operators: - **type**: *eq, in* - **created**: *gt, lt, ge, le* - **modified**: *gt, lt, ge, le* - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - Sorting is supported for the following fields: **type, created, modified** - responses: - '200': - description: List of account activities - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the account activity itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - completed: - type: string - format: date-time - nullable: true - example: '2018-10-19T13:49:37.385Z' - completionStatus: - nullable: true - type: string - enum: - - SUCCESS - - FAILURE - - INCOMPLETE - - PENDING - type: - type: string - example: appRequest - requesterIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - targetIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - errors: - nullable: true - type: array - items: - type: string - example: - - 'sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.' - warnings: - nullable: true - type: array - items: - type: string - example: - - 'Some warning, another warning' - items: - type: array - items: - type: object - properties: - id: - type: string - description: Item id - example: 2725138ee34949beb0d6cc982d2d4625 - name: - type: string - description: Human-readable display name of item - requested: - type: string - format: date-time - description: Date and time item was requested - example: '2017-07-11T18:45:37.098Z' - approvalStatus: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - provisioningStatus: - type: string - enum: - - PENDING - - FINISHED - - UNVERIFIABLE - - COMMITED - - FAILED - - RETRY - description: Provisioning state of an account activity item - requesterComment: - type: object - nullable: true - properties: - commenterId: - type: string - description: Id of the identity making the comment - example: 2c918084660f45d6016617daa9210584 - commenterName: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - body: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. - date: - type: string - format: date-time - description: Date and time comment was made - example: '2017-07-11T18:45:37.098Z' - reviewerIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - reviewerComment: - type: object - nullable: true - properties: - commenterId: - type: string - description: Id of the identity making the comment - example: 2c918084660f45d6016617daa9210584 - commenterName: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - body: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. - date: - type: string - format: date-time - description: Date and time comment was made - example: '2017-07-11T18:45:37.098Z' - operation: - type: string - enum: - - ADD - - CREATE - - MODIFY - - DELETE - - DISABLE - - ENABLE - - UNLOCK - - LOCK - - REMOVE - description: Represents an operation in an account activity item - attribute: - type: string - description: Attribute to which account activity applies - nullable: true - example: detectedRoles - value: - type: string - description: Value of attribute - nullable: true - example: 'Treasury Analyst [AccessProfile-1529010191212]' - nativeIdentity: - nullable: true - type: string - description: Native identity in the target system to which the account activity applies - example: Sandie.Camero - sourceId: - type: string - description: Id of Source to which account activity applies - example: 2c91808363ef85290164000587130c0c - accountRequestInfo: - type: object - nullable: true - properties: - requestedObjectId: - type: string - description: Id of requested object - example: 2c91808563ef85690164001c31140c0c - requestedObjectName: - type: string - description: Human-readable name of requested object - example: Treasury Analyst - requestedObjectType: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice. - example: ACCESS_PROFILE - description: 'If an account activity item is associated with an access request, captures details of that request.' - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: 'Arbitrary key-value pairs, if any were included in the corresponding access request item' - removeDate: - nullable: true - type: string - description: The date the role or access profile is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - executionStatus: - type: string - enum: - - EXECUTING - - VERIFYING - - TERMINATED - - COMPLETED - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: 'Arbitrary key-value pairs, if any were included in the corresponding access request' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/account-activities/{id}': - get: - operationId: getAccountActivity - tags: - - Account Activities - summary: Get an Account Activity - description: This gets a single account activity by its id. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The account activity id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An account activity object - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Id of the account activity itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - completed: - type: string - format: date-time - nullable: true - example: '2018-10-19T13:49:37.385Z' - completionStatus: - nullable: true - type: string - enum: - - SUCCESS - - FAILURE - - INCOMPLETE - - PENDING - type: - type: string - example: appRequest - requesterIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - targetIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - errors: - nullable: true - type: array - items: - type: string - example: - - 'sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.' - warnings: - nullable: true - type: array - items: - type: string - example: - - 'Some warning, another warning' - items: - type: array - items: - type: object - properties: - id: - type: string - description: Item id - example: 2725138ee34949beb0d6cc982d2d4625 - name: - type: string - description: Human-readable display name of item - requested: - type: string - format: date-time - description: Date and time item was requested - example: '2017-07-11T18:45:37.098Z' - approvalStatus: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - provisioningStatus: - type: string - enum: - - PENDING - - FINISHED - - UNVERIFIABLE - - COMMITED - - FAILED - - RETRY - description: Provisioning state of an account activity item - requesterComment: - type: object - nullable: true - properties: - commenterId: - type: string - description: Id of the identity making the comment - example: 2c918084660f45d6016617daa9210584 - commenterName: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - body: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. - date: - type: string - format: date-time - description: Date and time comment was made - example: '2017-07-11T18:45:37.098Z' - reviewerIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - reviewerComment: - type: object - nullable: true - properties: - commenterId: - type: string - description: Id of the identity making the comment - example: 2c918084660f45d6016617daa9210584 - commenterName: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - body: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. - date: - type: string - format: date-time - description: Date and time comment was made - example: '2017-07-11T18:45:37.098Z' - operation: - type: string - enum: - - ADD - - CREATE - - MODIFY - - DELETE - - DISABLE - - ENABLE - - UNLOCK - - LOCK - - REMOVE - description: Represents an operation in an account activity item - attribute: - type: string - description: Attribute to which account activity applies - nullable: true - example: detectedRoles - value: - type: string - description: Value of attribute - nullable: true - example: 'Treasury Analyst [AccessProfile-1529010191212]' - nativeIdentity: - nullable: true - type: string - description: Native identity in the target system to which the account activity applies - example: Sandie.Camero - sourceId: - type: string - description: Id of Source to which account activity applies - example: 2c91808363ef85290164000587130c0c - accountRequestInfo: - type: object - nullable: true - properties: - requestedObjectId: - type: string - description: Id of requested object - example: 2c91808563ef85690164001c31140c0c - requestedObjectName: - type: string - description: Human-readable name of requested object - example: Treasury Analyst - requestedObjectType: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice. - example: ACCESS_PROFILE - description: 'If an account activity item is associated with an access request, captures details of that request.' - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: 'Arbitrary key-value pairs, if any were included in the corresponding access request item' - removeDate: - nullable: true - type: string - description: The date the role or access profile is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - executionStatus: - type: string - enum: - - EXECUTING - - VERIFYING - - TERMINATED - - COMPLETED - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: 'Arbitrary key-value pairs, if any were included in the corresponding access request' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /certifications: - get: - operationId: listIdentityCertifications - tags: - - Certifications - summary: Identity Campaign Certifications by IDs - description: 'This API returns a list of identity campaign certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to Governance Groups.' - parameters: - - in: query - name: reviewer-identity - schema: - type: string - description: The ID of reviewer identity. *me* indicates the current user. - required: false - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - Filtering is supported for the following fields and operators: - **id**: *eq, in* - **campaign.id**: *eq, in* - **phase**: *eq* - **completed**: *eq, ne* - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - Sorting is supported for the following fields: **name, due, signed** - responses: - '200': - description: List of identity campaign certifications - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - type: boolean - example: false - errorMessage: - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}': - get: - operationId: getIdentityCertification - tags: - - Certifications - summary: Identity Certification by ID - description: This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The certification id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An identity campaign certification object - content: - application/json: - schema: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - type: boolean - example: false - errorMessage: - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}/access-review-items': - get: - operationId: listIdentityAccessReviewItems - tags: - - Certifications - summary: List of Access Review Items - description: This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **type / access.type**: *eq* - - **completed**: *eq, ne* - - **identitySummary.id**: *eq, in* - - **identitySummary.name**: *eq, sw* - - **access.id**: *eq, in* - - **access.name**: *eq, sw* - - **entitlement.sourceName**: *eq, sw* - - **accessProfile.sourceName**: *eq, sw* - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - - in: query - name: entitlements - schema: - type: string - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. - - An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - - in: query - name: access-profiles - schema: - type: string - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. - - An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - - in: query - name: roles - schema: - type: string - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated role IDs. - - An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - responses: - '200': - description: A list of access review items - content: - application/json: - schema: - type: array - items: - type: object - properties: - accessSummary: - type: object - description: An object holding the access that is being reviewed - properties: - access: - type: object - properties: - type: - description: The type of item being certified - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: The ID of the item being certified - example: 2c9180867160846801719932c5153fb7 - name: - type: string - description: The name of the item being certified - example: Entitlement for Company Database - entitlement: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - accessProfile: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - description: Owner of the Access Profile - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - role: - type: object - nullable: true - properties: - id: - type: string - description: The id for the Role - example: 2c91808a7190d06e0171993907fd0794 - name: - type: string - description: The name of the Role - example: Accounting-Employees - description: - type: string - description: Information about the Role - example: Role for members of the accounting department with the necessary Access Profiles - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - revocable: - type: boolean - description: Indicates whether the Role can be revoked or requested - endDate: - type: string - format: date-time - description: The date when a user's access expires. - example: '2021-12-25T00:00:00.000Z' - accessProfiles: - type: array - description: The list of Access Profiles associated with this Role - items: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - description: Owner of the Access Profile - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - identitySummary: - type: object - properties: - id: - type: string - description: The ID of the identity summary - example: 2c91808772a504f50172a9540e501ba7 - name: - type: string - description: Name of the linked identity - example: Alison Ferguso - identityId: - type: string - description: The ID of the identity being certified - example: 2c9180857182306001719937377a33de - completed: - type: boolean - description: Indicates whether the review items for the linked identity's certification have been completed - id: - type: string - description: The review item's id - example: ef38f94347e94562b5bb8424a56397d8 - completed: - type: boolean - description: Whether the review item is complete - example: false - newAccess: - type: boolean - description: Indicates whether the review item is for new access to a source - decision: - type: string - description: The decision to approve or revoke the review item - enum: - - APPROVE - - REVOKE - example: APPROVE - comments: - nullable: true - type: string - description: Comments for this review item - example: This user still needs access to this source - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}/decide': - post: - operationId: makeIdentityDecision - tags: - - Certifications - summary: Decide on a Certification Item - description: The API makes a decision to approve or revoke one or more identity campaign certification items. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the identity campaign certification on which to make decisions - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: A non-empty array of decisions to be made. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - decision: - type: string - description: The decision to approve or revoke the review item - enum: - - APPROVE - - REVOKE - example: APPROVE - proposedEndDate: - type: string - format: date-time - description: The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. - bulk: - type: boolean - description: Indicates whether decision should be marked as part of a larger bulk decision - example: true - recommendation: - nullable: true - type: object - properties: - recommendation: - type: string - description: The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. - reasons: - type: array - items: - type: string - description: A list of reasons for the recommendation. - timestamp: - type: string - format: date-time - description: The time at which the recommendation was recorded. - example: '2020-06-01T13:49:37.385Z' - comments: - type: string - description: Comments recorded when the decision was made - example: This user no longer needs access to this source - required: - - id - - decision - - bulk - minItems: 1 - maxItems: 250 - example: - - id: ef38f94347e94562b5bb8424a56396b5 - decision: APPROVE - bulk: true - comments: This user still needs access to this source. - - id: ef38f94347e94562b5bb8424a56397d8 - decision: APPROVE - bulk: true - comments: This user still needs access to this source too. - responses: - '200': - description: An identity campaign certification object - content: - application/json: - schema: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - type: boolean - example: false - errorMessage: - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}/reassign': - post: - operationId: reassignIdentityCertifications - tags: - - Certifications - summary: Reassign Identities or Items - description: This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - reassign: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of item or identity being reassigned. - example: ef38f94347e94562b5bb8424a56397d8 - type: - type: string - enum: - - TARGET_SUMMARY - - ITEM - - IDENTITY_SUMMARY - required: - - id - - type - reassignTo: - type: string - description: The ID of the identity to which the certification is reassigned - example: ef38f94347e94562b5bb8424a56397d8 - reason: - type: string - description: The reason comment for why the reassign was made - example: reassigned for some reason - required: - - reassign - - reassignTo - - reason - responses: - '200': - description: An identity campaign certification details after completing the reassignment. - content: - application/json: - schema: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - type: boolean - example: false - errorMessage: - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}/sign-off': - post: - operationId: signOffIdentityCertification - tags: - - Certifications - summary: Finalize Identity Certification Decisions - description: This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An identity campaign certification object - content: - application/json: - schema: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - type: boolean - example: false - errorMessage: - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}/decision-summary': - get: - operationId: getIdentityDecisionSummary - tags: - - Certification Summaries - summary: Summary of Certification Decisions - description: This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407) - - Filtering is supported for the following fields and operators: - - **identitySummary.id**: *eq, in* - responses: - '200': - description: Summary of the decisions made - content: - application/json: - schema: - type: object - properties: - entitlementDecisionsMade: - type: integer - description: Number of entitlement decisions that have been made - example: 3 - accessProfileDecisionsMade: - type: integer - description: Number of access profile decisions that have been made - example: 5 - roleDecisionsMade: - type: integer - description: Number of role decisions that have been made - example: 2 - accountDecisionsMade: - type: integer - description: Number of account decisions that have been made - example: 4 - entitlementDecisionsTotal: - type: integer - description: 'The total number of entitlement decisions on the certification, both complete and incomplete' - example: 6 - accessProfileDecisionsTotal: - type: integer - description: 'The total number of access profile decisions on the certification, both complete and incomplete' - example: 10 - roleDecisionsTotal: - type: integer - description: 'The total number of role decisions on the certification, both complete and incomplete' - example: 4 - accountDecisionsTotal: - type: integer - description: 'The total number of account decisions on the certification, both complete and incomplete' - example: 8 - entitlementsApproved: - type: integer - description: The number of entitlement decisions that have been made which were approved - example: 2 - entitlementsRevoked: - type: integer - description: The number of entitlement decisions that have been made which were revoked - example: 1 - accessProfilesApproved: - type: integer - description: The number of access profile decisions that have been made which were approved - example: 3 - accessProfilesRevoked: - type: integer - description: The number of access profile decisions that have been made which were revoked - example: 2 - rolesApproved: - type: integer - description: The number of role decisions that have been made which were approved - example: 2 - rolesRevoked: - type: integer - description: The number of role decisions that have been made which were revoked - example: 0 - accountsApproved: - type: integer - description: The number of account decisions that have been made which were approved - example: 1 - accountsRevoked: - type: integer - description: The number of account decisions that have been made which were revoked - example: 3 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}/identity-summaries': - get: - operationId: getIdentitySummaries - tags: - - Certification Summaries - summary: Identity Summaries for Identity Campaign Certification - description: This API returns a list of the identity summaries for a specific identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **completed**: *eq, ne* - - **name**: *eq, sw* - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - responses: - '200': - description: List of identity summaries - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the identity summary - example: 2c91808772a504f50172a9540e501ba7 - name: - type: string - description: Name of the linked identity - example: Alison Ferguso - identityId: - type: string - description: The ID of the identity being certified - example: 2c9180857182306001719937377a33de - completed: - type: boolean - description: Indicates whether the review items for the linked identity's certification have been completed - example: - - id: 2c91808772a504f50172a9540e501ba7 - name: Aaron Grey - identityId: 2c9180857182306001719937379633e4 - completed: false - - id: 2c91808772a504f50172a9540e501ba8 - name: Aglae Wilson - identityId: 2c9180857182306001719937377a33de - completed: true - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}/access-summaries/{type}': - get: - operationId: getIdentityAccessSummaries - tags: - - Certification Summaries - summary: Access Summaries - description: This API returns a list of access summaries for the specified identity campaign certification and type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: type - schema: - type: string - enum: - - ROLE - - ACCESS_PROFILE - - ENTITLEMENT - required: true - description: The type of access review item to retrieve summaries for - example: ACCESS_PROFILE - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407) - - Filtering is supported for the following fields and operators: - - **completed**: *eq, ne* - - **access.id**: *eq, in* - - **access.name**: *eq, sw* - - **entitlement.sourceName**: *eq, sw* - - **accessProfile.sourceName**: *eq, sw* - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **access.name** - responses: - '200': - description: List of access summaries - content: - application/json: - schema: - type: array - items: - type: object - description: An object holding the access that is being reviewed - properties: - access: - type: object - properties: - type: - description: The type of item being certified - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: The ID of the item being certified - example: 2c9180867160846801719932c5153fb7 - name: - type: string - description: The name of the item being certified - example: Entitlement for Company Database - entitlement: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - accessProfile: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - description: Owner of the Access Profile - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - role: - type: object - nullable: true - properties: - id: - type: string - description: The id for the Role - example: 2c91808a7190d06e0171993907fd0794 - name: - type: string - description: The name of the Role - example: Accounting-Employees - description: - type: string - description: Information about the Role - example: Role for members of the accounting department with the necessary Access Profiles - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - revocable: - type: boolean - description: Indicates whether the Role can be revoked or requested - endDate: - type: string - format: date-time - description: The date when a user's access expires. - example: '2021-12-25T00:00:00.000Z' - accessProfiles: - type: array - description: The list of Access Profiles associated with this Role - items: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - description: Owner of the Access Profile - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - description: Indicates if the entitlement is a privileged entitlement - owner: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - hasPermissions: - type: boolean - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - example: false - description: Indicates whether this account is currently locked - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - example: - - access: - type: ENTITLEMENT - id: 2c9180857182305e01719937429e2bad - name: CN=Engineering - entitlement: - id: 2c9180857182305e01719937429e2bad - name: CN=Engineering - description: Access to the engineering database - privileged: false - owner: - email: brandon.gray@acme-solar.com - type: IDENTITY - id: 2c9180867160846801719932c5153fb7 - name: Brandon Gray - attributeName: memberOf - attributeValue: CN=Engineering - sourceName: ODS-AD-Source - hasPermissions: true - revocable: true - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/certifications/{id}/identity-summary/{identitySummaryId}': - get: - operationId: getIdentitySummary - tags: - - Certification Summaries - summary: Summary for Identity - description: This API returns the summary for an identity on a specified identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: identitySummaryId - schema: - type: string - required: true - description: The identity summary ID - example: 2c91808772a504f50172a9540e501ba8 - responses: - '200': - description: An identity summary - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the identity summary - example: 2c91808772a504f50172a9540e501ba7 - name: - type: string - description: Name of the linked identity - example: Alison Ferguso - identityId: - type: string - description: The ID of the identity being certified - example: 2c9180857182306001719937377a33de - completed: - type: boolean - description: Indicates whether the review items for the linked identity's certification have been completed - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/identities/{identity-id}/set-lifecycle-state': - post: - operationId: setLifecycleState - tags: - - Lifecycle States - summary: Set Lifecycle State - description: |- - This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile. - A token with ORG_ADMIN or API authority is required to call this API. - security: - - oauth2: - - 'idn:identity-lifecycle-state:update' - parameters: - - in: path - name: identity-id - description: The ID of the identity to update - required: true - example: 2c9180857893f1290178944561990364 - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - lifecycleStateId: - type: string - description: The ID of the lifecycle state to set - example: 2c9180877a86e408017a8c19fefe046c - responses: - '200': - description: The request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - accountActivityId: - type: string - example: 2c9180837ab5b716017ab7c6c9ef1e20 - description: The ID of the IdentityRequest object that was generated when the workflow launches - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/identity-profiles/{identity-profile-id}/lifecycle-states': - get: - operationId: listLifecycleStates - tags: - - Lifecycle States - summary: Lists LifecycleStates - description: |- - This end-point lists all the LifecycleStates associated with IdentityProfiles. - A token with API, or ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:identity-profile-lifecycle-state:read' - parameters: - - in: path - name: identity-profile-id - description: The IdentityProfile id - required: true - schema: - type: string - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - responses: - '200': - description: List of LifecycleState objects - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createLifecycleState - tags: - - Lifecycle States - summary: Create Lifecycle State - description: |- - This API creates a new Lifecycle State. - A token with ORG_ADMIN or API authority is required to call this API. - security: - - oauth2: - - 'idn:identity-profile-lifecycle-state:create' - parameters: - - in: path - name: identity-profile-id - description: Identity Profile ID - required: true - schema: - type: string - requestBody: - description: Lifecycle State - required: true - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - responses: - '201': - description: Created LifecycleState object. - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}': - get: - operationId: getLifecycleState - tags: - - Lifecycle States - summary: Retrieves Lifecycle State - description: |- - This endpoint retrieves a Lifecycle State. - A token with ORG_ADMIN or API authority is required to call this API. - security: - - oauth2: - - 'idn:identity-profile-lifecycle-state:read' - parameters: - - in: path - name: identity-profile-id - description: Identity Profile ID - required: true - schema: - type: string - - in: path - name: lifecycle-state-id - description: Lifecycle State ID - required: true - schema: - type: string - responses: - '200': - description: The requested LifecycleState was successfully retrieved. - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: updateLifecycleStates - tags: - - Lifecycle States - summary: Update Lifecycle State - description: |- - This endpoint updates individual Lifecycle State fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - A token with ORG_ADMIN or API authority is required to call this API. - security: - - oauth2: - - 'idn:identity-profile-lifecycle-state:update' - parameters: - - in: path - name: identity-profile-id - description: Identity Profile ID - required: true - schema: - type: string - - in: path - name: lifecycle-state-id - description: Lifecycle State ID - required: true - schema: - type: string - requestBody: - required: true - description: | - A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields can be updated: - * enabled - * description - * accountActions - * accessProfileIds - * emailNotificationOption - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /description - value: Updated description! - - op: replace - path: /accessProfileIds - value: - - 2c918087742bab150174407a80f3125e - - 2c918087742bab150174407a80f3124f - - op: replace - path: /accountActions - value: - - action: ENABLE - sourceIds: - - 2c9180846a2f82fb016a481c1b1560c5 - - 2c9180846a2f82fb016a481c1b1560cc - - action: DISABLE - sourceIds: - - 2c91808869a0c9980169a207258513fb - - op: replace - path: /emailNotificationOption - value: - notifyManagers: true - notifyAllAdmins: false - notifySpecificUsers: false - emailAddressList: [] - responses: - '200': - description: The LifecycleState was successfully updated. - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - example: true - description: Whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The technical name for lifecycle state. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - example: true - description: 'If true, then the manager is notified of the lifecycle state change.' - notifyAllAdmins: - type: boolean - example: true - description: 'If true, then all the admins are notified of the lifecycle state change.' - notifySpecificUsers: - type: boolean - example: true - description: 'If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.' - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: 'List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.' - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteLifecycleState - tags: - - Lifecycle States - summary: Delete Lifecycle State by ID - description: |- - This endpoint deletes the Lifecycle State using it's ID. - A token with API, or ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:identity-profile-lifecycle-state:delete' - parameters: - - in: path - name: identity-profile-id - description: Identity Profile ID - required: true - schema: - type: string - - in: path - name: lifecycle-state-id - description: Lifecycle State ID - required: true - schema: - type: string - responses: - '202': - description: The request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /identity-profiles: - get: - operationId: listIdentityProfiles - tags: - - Identity Profiles - summary: Identity Profiles List - description: |- - This returns a list of Identity Profiles based on the specified query parameters. - A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, ne* - - **name**: *eq, ne* - - **priority**: *eq, ne* - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id**, **name**, **priority** - responses: - '200': - description: List of identityProfiles. - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - - type: object - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - owner: - description: The owner of the Identity Profile. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2c918086795cd09201795d5f7d7533df - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - example: true - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:identity-profile:read' - /identity-profiles/export: - get: - operationId: exportIdentityProfiles - tags: - - Identity Profiles - summary: Export Identity Profiles - description: This exports existing identity profiles in the format specified by the sp-config service. - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, ne* - - **name**: *eq, ne* - - **priority**: *eq, ne* - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id**, **name**, **priority** - responses: - '200': - description: List of export objects with identity profiles. - content: - application/json: - schema: - type: array - items: - type: object - description: Identity Profile exported object - properties: - version: - type: integer - example: 1 - description: Version or object from the target service. - self: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - object: - allOf: - - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - - type: object - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - owner: - description: The owner of the Identity Profile. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2c918086795cd09201795d5f7d7533df - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - example: true - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:identity-profile:read' - /identity-profiles/import: - post: - operationId: importIdentityProfiles - summary: Import Identity Profiles - description: This imports previously exported identity profiles. - tags: - - Identity Profiles - requestBody: - description: Previously exported Identity Profiles. - required: true - content: - application/json: - schema: - type: array - items: - type: object - description: Identity Profile exported object - properties: - version: - type: integer - example: 1 - description: Version or object from the target service. - self: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - object: - allOf: - - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - - type: object - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - owner: - description: The owner of the Identity Profile. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2c918086795cd09201795d5f7d7533df - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - example: true - responses: - '200': - description: The result of importing Identity Profiles. - content: - application/json: - schema: - type: object - title: Import Object Response Body - description: Response model for import of a single object. - properties: - infos: - description: Informational messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: 'Message details if any, in key:value pairs.' - additionalProperties: - type: object - example: - details: message details - required: - - key - - text - - details - warnings: - description: Warning messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: 'Message details if any, in key:value pairs.' - additionalProperties: - type: object - example: - details: message details - required: - - key - - text - - details - errors: - description: Error messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: 'Message details if any, in key:value pairs.' - additionalProperties: - type: object - example: - details: message details - required: - - key - - text - - details - importedObjects: - description: References to objects that were created or updated by the import. - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - required: - - infos - - warnings - - errors - - importedObjects - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:identity-profile:create' - '/identity-profiles/{identity-profile-id}': - get: - operationId: getIdentityProfile - tags: - - Identity Profiles - summary: Get single Identity Profile - description: |- - This returns a single Identity Profile based on ID. - A token with ORG_ADMIN or API authority is required to call this API. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - description: The Identity Profile ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An Identity Profile object. - content: - application/json: - schema: - allOf: - - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - - type: object - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - owner: - description: The owner of the Identity Profile. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2c918086795cd09201795d5f7d7533df - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - example: true - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:identity-profile:read' - '/identity-profiles/{identity-profile-id}/default-identity-attribute-config': - get: - operationId: getDefaultIdentityAttributeConfig - tags: - - Identity Profiles - summary: Get default Identity Attribute Config - description: |- - This returns the default identity attribute config. - A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - description: The Identity Profile ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An Identity Attribute Config object. - content: - application/json: - schema: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:identity-profile-default-mapping:read' - /non-employee-records: - post: - operationId: nonEmployeeRecordCreation - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Record - description: |- - This request will create a non-employee record.

- Requires role context of `idn:nesr:create` - requestBody: - description: Non-Employee record creation request body. - required: true - content: - application/json: - schema: - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - required: - - accountName - - firstName - - lastName - - email - - phone - - manager - - sourceId - - startDate - - endDate - responses: - '200': - description: Created non-employee record. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - accountName: - type: string - description: Requested identity account name. - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - get: - operationId: nonEmployeeRecordList - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Records - description: |- - This gets a list of non-employee records.

There are two contextual uses for this endpoint:
- 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees.
- 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: 'accountName,sourceId' - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)

Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**' - - in: query - name: filters - required: false - schema: - type: string - example: sourceId eq "2c91808568c529c60168cca6f90c1313" - description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)

Filtering is supported for the following fields and operators:

**sourceId**: *eq*

*Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"' - responses: - '200': - description: Non-Employee record objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - accountName: - type: string - description: Requested identity account name. - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-records/{id}': - get: - operationId: nonEmployeeRecordGet - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Record - description: |- - This gets a non-employee record.

- Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Non-Employee record id (UUID) - required: true - example: ef38f94347e94562b5bb8424a56397d8 - schema: - type: string - responses: - '200': - description: Non-Employee record object - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - accountName: - type: string - description: Requested identity account name. - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: nonEmployeeRecordUpdate - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Update Non-Employee Record - description: |- - This request will update a non-employee record.

There are two contextual uses for this endpoint:
- 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields.
- 2. The user is owner of the source, in this case they can only update the end date. - parameters: - - in: path - name: id - description: Non-employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - schema: - type: string - requestBody: - description: Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - required: true - content: - application/json: - schema: - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - required: - - accountName - - firstName - - lastName - - email - - phone - - manager - - sourceId - - startDate - - endDate - responses: - '200': - description: An updated non-employee record. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - accountName: - type: string - description: Requested identity account name. - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: nonEmployeeRecordPatch - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Patch Non-Employee Record - description: |- - This request will patch a non-employee record.

There are two contextual uses for this endpoint:
- 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields.
- 2. The user is owner of the source, in this case they can only update the end date. - parameters: - - in: path - name: id - description: Non-employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - schema: - type: string - requestBody: - description: 'A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.' - required: true - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /endDate - value: '2019-08-23T18:40:35.772Z' - responses: - '200': - description: A patched non-employee record. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - accountName: - type: string - description: Requested identity account name. - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: nonEmployeeRecordDelete - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Record - description: |- - This request will delete a non-employee record.

- Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: id - description: Non-Employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - schema: - type: string - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /non-employee-records/bulk-delete: - post: - operationId: nonEmployeeRecordBulkDelete - tags: - - Non-Employee Lifecycle Management - summary: Delete Multiple Non-Employee Records - description: 'This request will delete multiple non-employee records based on the non-employee ids provided.

Requires role context of `idn:nesr:delete`' - requestBody: - description: Non-Employee bulk delete request body. - required: true - content: - application/json: - schema: - type: object - properties: - ids: - description: List of non-employee ids. - type: array - items: - type: string - format: uuid - required: - - ids - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /non-employee-requests: - post: - operationId: nonEmployeeRequestCreation - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Request - description: 'This request will create a non-employee request and notify the approver.

Requires role context of `idn:nesr:create` or the user must own the source.' - requestBody: - description: Non-Employee creation request body - required: true - content: - application/json: - schema: - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - required: - - accountName - - firstName - - lastName - - email - - phone - - manager - - sourceId - - startDate - - endDate - responses: - '200': - description: Non-Employee request creation object - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - approvalItems: - description: List of approval item for the request - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - approvalOrder: - type: number - description: Approval order - example: 1 - comment: - type: string - description: comment of approver - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - comment: - type: string - description: comment of requester - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - 400.1 Bad Request Content: - description: Response for bad request content - value: - detailCode: 400.1 Bad Request Content - trackingId: e7eab60924f64aa284175b9fa3309599 - messages: - - locale: en - localeOrigin: REQUEST - text: firstName is required; accountName is required; - 400.1.409 Reference conflict: - description: Response for reference conflict - value: - detailCode: 400.1.409 Reference conflict - trackingId: e7eab60924f64aa284175b9fa3309599 - messages: - - locale: en - localeOrigin: REQUEST - text: Unable to create Non-Employee because the accountName "existed" is already being used. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - get: - operationId: nonEmployeeRequestList - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Requests - description: |- - This gets a list of non-employee requests.

There are two contextual uses for the `requested-for` path parameter:
- 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.
- 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: requested-for - required: true - schema: - type: string - example: me - description: The identity for whom the request was made. *me* indicates the current user. - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: 'created,approvalStatus' - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)

Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**' - - in: query - name: filters - required: false - schema: - type: string - example: sourceId eq "2c91808568c529c60168cca6f90c1313" - description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)

Filtering is supported for the following fields and operators:

**sourceId**: *eq*

*Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"' - responses: - '200': - description: List of non-employee request objects. - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - approvalItems: - description: List of approval item for the request - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - approvalOrder: - type: number - description: Approval order - example: 1 - comment: - type: string - description: comment of approver - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - comment: - type: string - description: comment of requester - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-requests/{id}': - get: - operationId: nonEmployeeRequestGet - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Request - description: |- - This gets a non-employee request.

- There are two contextual uses for this endpoint:
- 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user.
- 2. The user must be the owner of the non-employee request. - parameters: - - in: path - name: id - description: Non-Employee request id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - schema: - type: string - responses: - '200': - description: Non-Employee request object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - approvalItems: - description: List of approval item for the request - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - approvalOrder: - type: number - description: Approval order - example: 1 - comment: - type: string - description: comment of approver - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - comment: - type: string - description: comment of requester - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: nonEmployeeRequestDeletion - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Request - description: |- - This request will delete a non-employee request.

- Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: id - description: Non-Employee request id in the UUID format - required: true - schema: - type: string - format: uuid - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-requests/summary/{requested-for}': - get: - operationId: nonEmployeeRequestSummaryGet - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Summary of Non-Employee Requests - description: |- - This request will retrieve a summary of non-employee requests.

There are two contextual uses for the `requested-for` path parameter:
- 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id.
- 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - parameters: - - in: path - name: requested-for - description: The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use "me" instead to indicate the current user. - required: true - schema: - type: string - format: uuid (if user is Org Admin) - responses: - '200': - description: Non-Employee request summary object. - content: - application/json: - schema: - type: object - properties: - approved: - type: number - description: The number of approved non-employee requests on all sources that *requested-for* user manages. - rejected: - type: number - description: The number of rejected non-employee requests on all sources that *requested-for* user manages. - pending: - type: number - description: The number of pending non-employee requests on all sources that *requested-for* user manages. - nonEmployeeCount: - type: number - description: The number of non-employee records on all sources that *requested-for* user manages. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /non-employee-sources: - post: - operationId: nonEmployeeSourcesCreation - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Source - description: 'This request will create a non-employee source.

Requires role context of `idn:nesr:create`' - requestBody: - description: Non-Employee source creation request body. - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Name of non-employee source. - example: Retail - description: - type: string - description: Description of non-employee source. - example: Source description - owner: - description: Owner of non-employee source. - type: object - properties: - id: - type: string - format: UUID - description: Identity id. - example: 2c91808570313110017040b06f344ec9 - required: - - id - managementWorkgroup: - type: string - description: The ID for the management workgroup that contains source sub-admins - example: '123299' - approvers: - description: List of approvers. - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Identity id. - example: 2c91808570313110017040b06f344ec9 - required: - - id - maxItems: 3 - accountManagers: - description: List of account managers. - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Identity id. - example: 2c91808570313110017040b06f344ec9 - required: - - id - maxItems: 10 - required: - - owner - - name - - description - responses: - '200': - description: Created non-employee source. - content: - application/json: - schema: - allOf: - - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - cloudExternalId: - type: string - description: Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - example: '99999' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - get: - operationId: nonEmployeeSourcesList - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Sources - description: |- - This gets a list of non-employee sources.

There are two contextual uses for the requested-for path parameter:
- 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list sources assigned to a particular account manager by passing in that manager's id.
- 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: requested-for - required: true - schema: - type: string - example: me - description: The identity for whom the request was made. *me* indicates the current user. - - in: query - name: non-employee-count - required: false - example: true - schema: - type: boolean - description: The flag to determine whether return a non-employee count associate with source. - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: 'name,created' - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)

Sorting is supported for the following fields: **name, created**' - responses: - '200': - description: List of non-employee sources objects. - content: - application/json: - schema: - type: array - items: - allOf: - - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeCount: - type: number - description: Number of non-employee records associated with this source. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-sources/{sourceId}': - get: - operationId: nonEmployeeSourceGet - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Source - description: |- - This gets a non-employee source.

There are two contextual uses for the requested-for path parameter:
- 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source.
- 2. The current user is an account manager, in which case the user can only request sources that they own. - parameters: - - in: path - name: sourceId - description: Source Id - example: 2c91808b7c28b350017c2a2ec5790aa1 - required: true - schema: - type: string - responses: - '200': - description: Non-Employee source object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: nonEmployeeSourcePatch - tags: - - Non-Employee Lifecycle Management - summary: Patch a Non-Employee Source - description: 'patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers**

Requires role context of `idn:nesr:update`.' - parameters: - - in: path - name: sourceId - description: Source Id - required: true - schema: - type: string - requestBody: - description: 'A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.' - required: true - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /name - value: - new name: null - - op: replace - path: /approvers - value: - - 2c91809f703bb37a017040a2fe8748c7 - - 48b1f463c9e8427db5a5071bd81914b8 - responses: - '200': - description: A patched non-employee source object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: nonEmployeeSourceDelete - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Source - description: 'This request will delete a non-employee source.

Requires role context of `idn:nesr:delete`.' - parameters: - - in: path - name: sourceId - description: Source Id - required: true - schema: - type: string - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-sources/{id}/non-employees/download': - get: - operationId: nonEmployeeRecordsExport - tags: - - Non-Employee Lifecycle Management - summary: Exports Non-Employee Records to CSV - description: 'This requests a CSV download for all non-employees from a provided source.

Requires role context of `idn:nesr:read`' - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - schema: - type: string - responses: - '200': - description: Exported CSV - content: - text/csv: - example: | - accountName,firstName,lastName,phone,email,manager,startDate,endDate - Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 - William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-sources/{id}/non-employee-bulk-upload': - post: - operationId: nonEmployeeRecordsBulkUpload - tags: - - Non-Employee Lifecycle Management - summary: 'Imports, or Updates, Non-Employee Records' - description: 'This post will import, or update, Non-Employee records found in the CSV.

Requires role context of `idn:nesr:create`' - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - schema: - type: string - requestBody: - description: The form-data "name" attribute for the file content must be "data". See the schema specification. - content: - multipart/form-data: - schema: - type: object - properties: - data: - type: string - format: base64 - required: - - data - example: - data: 'accountName,firstName,lastName,phone,email,manager,startDate,endDate Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00 William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00, 2020-08-07T19:00:00-10:00' - responses: - '202': - description: The CSV was accepted to be bulk inserted now or at a later time. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The bulk upload job's ID. (UUID) - example: 2c91808568c529c60168cca6f90cffff - sourceId: - type: string - description: The ID of the source to bulk-upload non-employees to. (UUID) - example: 2c91808568c529c60168cca6f90c1313 - created: - type: string - format: date-time - description: The date-time the job was submitted. - example: '2019-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: The date-time that the job was last updated. - example: '2019-08-23T18:52:59.162Z' - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - COMPLETED - - ERROR - description: | - Returns the following values indicating the progress or result of the bulk upload job. - "PENDING" means the job is queued and waiting to be processed. - "IN_PROGRESS" means the job is currently being processed. - "COMPLETED" means the job has been completed without any errors. - "ERROR" means the job failed to process with errors. - example: PENDING - '400': - description: | - Client Error - Returned if the request body is invalid. - The response body will contain the list of specific errors with one on each line. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-sources/{id}/non-employee-bulk-upload/status': - get: - operationId: nonEmployeeBulkUploadStatus - tags: - - Non-Employee Lifecycle Management - summary: Obtain the status of bulk upload on the source - description: | - The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.

- Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Source ID (UUID) - required: true - schema: - type: string - responses: - '200': - description: 'Status of the newest bulk-upload job, if any.' - content: - application/json: - schema: - type: object - properties: - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - COMPLETED - - ERROR - description: | - Returns the following values indicating the progress or result of the bulk upload job. - "PENDING" means the job is queued and waiting to be processed. - "IN_PROGRESS" means the job is currently being processed. - "COMPLETED" means the job has been completed without any errors. - "ERROR" means the job failed to process with errors. - null means job has been submitted to the source. - example: PENDING - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-sources/{id}/schema-attributes-template/download': - get: - operationId: nonEmployeeExportSourceSchemaTemplate - tags: - - Non-Employee Lifecycle Management - summary: Exports Source Schema Template - description: 'This requests a download for the Source Schema Template for a provided source.

Requires role context of `idn:nesr:read`' - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - schema: - type: string - responses: - '200': - description: Exported Source Schema Template - content: - text/csv: - example: | - accountName,firstName,lastName,phone,email,manager,startDate,endDate - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /non-employee-approvals: - get: - operationId: nonEmployeeApprovalList - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Get List of Non-Employee Approval Requests - description: |- - This gets a list of non-employee approval requests.

- There are two contextual uses for this endpoint:
- 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver.
- 2. The user owns the requested approval. - parameters: - - in: query - name: requested-for - schema: - type: string - description: The identity for whom the request was made. *me* indicates the current user. - required: false - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: 'Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)

Filtering is supported for the following fields and operators:

**approvalStatus**: *eq*

*Example:* approvalStatus eq "PENDING"' - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)

Sorting is supported for the following fields: **created, modified**' - responses: - '200': - description: List of approval items. - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - approvalOrder: - type: number - description: Approval order - example: 1 - comment: - type: string - description: comment of approver - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeRequest: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - requester: - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-approvals/{id}': - get: - operationId: nonEmployeeApprovalGet - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a non-employee approval item detail - description: |- - Gets a non-employee approval item detail.

There are two contextual uses for this endpoint:
- 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval.
- 2. The user owns the requested approval. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - schema: - type: string - - in: query - name: include-detail - description: The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - required: false - schema: - type: string - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - approvalOrder: - type: number - description: Approval order - example: 1 - comment: - type: string - description: comment of approver - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeRequest: - description: Non-Employee request associated to this approval - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - requester: - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5555555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - schemaAttributes: - description: List of schema attributes associated with this non-employee source. - type: array - items: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - data: - type: object - additionalProperties: - type: string - description: Attribute blob/bag for a non-employee. - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - comment: - type: string - description: comment of requester - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date - description: Non-Employee employment start date. - example: '2020-03-24' - endDate: - type: string - format: date - description: Non-Employee employment end date. - example: '2021-03-25' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-approvals/{id}/approve': - post: - operationId: nonEmployeeApproveRequest - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Approve a Non-Employee Request - description: Approves a non-employee approval request and notifies the next approver.

The current user must be the requested approver. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Comment on the approval item. - maxLength: 4000 - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - approvalOrder: - type: number - description: Approval order - example: 1 - comment: - type: string - description: comment of approver - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeRequest: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - requester: - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-approvals/{id}/reject': - post: - operationId: nonEmployeeRejectRequest - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Reject a Non-Employee Request - description: This endpoint will reject an approval item request and notify user.

The current user must be the requested approver. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Comment on the approval item. - maxLength: 4000 - required: - - comment - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - description: Reference to the associated Identity - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - approvalOrder: - type: number - description: Approval order - example: 1 - comment: - type: string - description: comment of approver - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - - type: object - properties: - nonEmployeeRequest: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - requester: - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-approvals/summary/{requested-for}': - get: - operationId: nonEmployeeApprovalSummary - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Summary of Non-Employee Approval Requests - description: |- - This request will retrieve a summary of non-employee approval requests.

There are two contextual uses for the `requested-for` path parameter:
- 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id.
- 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - parameters: - - in: path - name: requested-for - schema: - type: string - description: The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use "me" instead to indicate the current user. - required: true - responses: - '200': - description: summary of non-employee approval requests - content: - application/json: - schema: - type: object - properties: - approved: - type: number - description: The number of approved non-employee approval requests. - pending: - type: number - description: The number of pending non-employee approval requests. - rejected: - type: number - description: The number of rejected non-employee approval requests. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-sources/{sourceId}/schema-attributes': - get: - operationId: getSchemaAttributes - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: List Schema Attributes Non-Employee Source - description: |- - This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.

- Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - responses: - '200': - description: A list of Schema Attributes - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - maxItems: 18 - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Create a new Schema Attribute for Non-Employee Source - description: |- - This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response.

- Requires role context of `idn:nesr:create` - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - type: - type: string - description: Type of the attribute. Only type 'TEXT' is supported for custom attributes. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - responses: - '200': - description: Schema Attribute created. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteSchemaAttributes - tags: - - Non-Employee Lifecycle Management - summary: Delete all custom schema attributes for Non-Employee Source - description: 'This end-point deletes all custom schema attributes for a non-employee source.

Requires role context of `idn:nesr:delete`' - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - responses: - '204': - description: All custon Schema Attributes were successfully deleted. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/non-employee-sources/{sourceId}/schema-attributes/{attributeId}': - get: - operationId: getSchemaAttribute - security: - - oauth2: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Schema Attribute Non-Employee Source - description: 'This API gets a schema attribute by Id for the specified Non-Employee SourceId.

Requires role context of `idn:nesr:read` or the user must be an account manager of the source.' - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - description: The Schema Attribute Id (UUID) - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - responses: - '200': - description: The Schema Attribute - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: patchSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Patch a Schema Attribute for Non-Employee Source - description: | - This end-point patches a specific schema attribute for a non-employee SourceId.

- Requires role context of `idn:nesr:update` - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - description: The Schema Attribute Id (UUID) - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - requestBody: - description: 'A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update '':'' ''label'', ''helpText'', ''placeholder'', ''required''.' - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /label - value: - new attribute label: null - required: true - responses: - '200': - description: The Schema Attribute was successfully patched. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: 'If true, the schema attribute is required for all non-employees in the source' - example: true - required: - - type - - technicalName - - label - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Delete a Schema Attribute for Non-Employee Source - description: | - This end-point deletes a specific schema attribute for a non-employee source.

- Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - description: The Schema Attribute Id (UUID) - - in: path - name: sourceId - schema: - type: string - required: true - description: The Source id - responses: - '204': - description: The Schema Attribute was successfully deleted. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /oauth-clients: - get: - operationId: listOauthClients - tags: - - OAuth Clients - summary: List OAuth Clients - description: |- - This gets a list of OAuth clients. - Request will require the following security scope: - - 'idn:oathkeeper-client-list:read' - responses: - '200': - description: List of OAuth clients. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - businessName: - type: string - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - type: string - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: string - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was created' - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was last updated' - example: '2018-06-25T20:22:28.104Z' - required: - - id - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createOauthClient - tags: - - OAuth Clients - summary: Create OAuth Client - description: |- - This creates an OAuth client. - Request will require the following security scope: - - 'idn:oathkeeper-client:create' - 'idn:oathkeeper-internal-client:create' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - businessName: - type: string - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - type: string - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: string - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - items: - type: string - description: A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal within the product. - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - required: - - name - - description - - accessTokenValiditySeconds - - grantTypes - - accessType - - enabled - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - secret: - type: string - description: Secret of the OAuth client (This field is only returned on the intial create call.) - example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 - businessName: - type: string - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - type: string - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: string - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was created' - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was last updated' - example: '2018-06-25T20:22:28.104Z' - required: - - id - - secret - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/oauth-clients/{id}': - get: - operationId: getOauthClient - tags: - - OAuth Clients - summary: Get OAuth Client - description: |- - This gets details of an OAuth client. - Request will require the following security scope: - - 'idn:oathkeeper-client:read' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - businessName: - type: string - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - type: string - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: string - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was created' - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was last updated' - example: '2018-06-25T20:22:28.104Z' - required: - - id - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteOauthClient - tags: - - OAuth Clients - summary: Delete OAuth Client - description: |- - This deletes an OAuth client. - Request will require the following security scopes: - - 'idn:oathkeeper-client:delete' - 'idn:oathkeeper-internal-client:delete' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: patchOauthClient - tags: - - OAuth Clients - summary: Patch OAuth Client - description: |- - This performs a targeted update to the field(s) of an OAuth client. - Request will require a security scope of - 'idn:oathkeeper-client:update' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * tenant - * businessName - * homepageUrl - * name - * description - * accessTokenValiditySeconds - * refreshTokenValiditySeconds - * redirectUris - * grantTypes - * accessType - * enabled - * strongAuthSupported - * claimsSupported - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: - - op: replace - path: /strongAuthSupported - value: true - - op: replace - path: /businessName - value: acme-solar - responses: - '200': - description: 'Indicates the PATCH operation succeeded, and returns the OAuth client''s new representation.' - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - businessName: - type: string - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - description: The homepage URL associated with the owner of the API Client - example: 'http://localhost:12345' - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - description: A description of the API Client - example: 'An API client used for the authorization_code, refresh_token, and client_credentials flows' - accessTokenValiditySeconds: - type: string - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: string - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - 'http://localhost:12345' - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - description: The access type (online or offline) of this API Client - example: OFFLINE - type: string - enum: - - ONLINE - - OFFLINE - type: - description: The type of the API Client (public or confidential) - example: CONFIDENTIAL - type: string - enum: - - CONFIDENTIAL - - PUBLIC - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was created' - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when the API Client was last updated' - example: '2018-06-25T20:22:28.104Z' - required: - - id - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /personal-access-tokens: - get: - operationId: listPersonalAccessTokens - tags: - - Personal Access Tokens - summary: List Personal Access Tokens - description: |- - This gets a collection of personal access tokens associated with the optional owner-id.
query parameter. If the owner-id query parameter is omitted, all personal access tokens
for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.

Any of the following rights are required to access this resource:
    -
  • idn:my-personal-access-tokens:read
    • -
  • idn:all-personal-access-tokens:read
    • -
  • idn:managed-personal-access-tokens:read
    • -
- parameters: - - in: query - name: owner-id - description: 'The identity ID of the owner whose personal access tokens should be listed.
If "me", the caller should have the following right: ''idn:my-personal-access-tokens:read''

If an actual owner ID or if the owner-id parameter is omitted in the request,
the caller should have the following right: ''idn:all-personal-access-tokens:read''.

If the caller has the following right, then managed personal access tokens associated with owner-id
will be retrieved: ''idn:managed-personal-access-tokens:read''' - required: false - schema: - type: string - default: null - example: 2c9180867b50d088017b554662fb281e - responses: - '200': - description: List of personal access tokens. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - owner: - description: Details about the owner of the personal access token. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when this personal access token was created.' - example: '2017-07-11T18:45:37.098Z' - required: - - id - - name - - owner - - created - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createPersonalAccessToken - tags: - - Personal Access Tokens - summary: Create Personal Access Token - description: |- - This creates a personal access token.

Any of the following rights are required to access this resource:
    -
  • idn:my-personal-access-tokens:create
    • -
  • idn:all-personal-access-tokens:create
    • -
  • idn:managed-personal-access-tokens:create
    • -
- requestBody: - description: Name and scope of personal access token. - required: true - content: - application/json: - schema: - type: object - description: Object for specifying the name of a personal access token to create - properties: - name: - type: string - description: The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - example: NodeJS Integration - required: - - name - responses: - '200': - description: Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - secret: - type: string - description: The secret of the personal access token (to be used as the password for Basic Auth). - example: 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - owner: - description: Details about the owner of the personal access token. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - created: - type: string - format: date-time - description: 'The date and time, down to the millisecond, when this personal access token was created.' - example: '2017-07-11T18:45:37.098Z' - required: - - id - - secret - - name - - owner - - created - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/personal-access-tokens/{id}': - delete: - operationId: deletePersonalAccessToken - tags: - - Personal Access Tokens - summary: Delete Personal Access Token - description: |- - This deletes a personal access token

Any of the following rights are required to access this resource:
    -
  • idn:my-personal-access-tokens:delete
    • -
  • idn:all-personal-access-tokens:delete
    • -
  • idn:managed-personal-access-tokens:delete
    • -
- parameters: - - in: path - name: id - schema: - type: string - required: true - description: The personal access token id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /public-identities: - get: - operationId: getPublicIdentities - tags: - - Public Identities - summary: Get a list of public identities - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **alias**: *eq, sw* - - **email**: *eq, sw* - - **firstname**: *eq, sw* - - **lastname**: *eq, sw* - - in: query - name: add-core-filters - description: |- - If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - - Should be either correlated or protected. - - Should not be "spadmin" or "cloudadmin". - - uid should not be null. - - lastname should not be null. - - email should not be null. - required: false - schema: - type: boolean - default: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - responses: - '200': - description: A list of public identity objects. - content: - application/json: - schema: - type: array - items: - type: object - title: Public Identity - description: Details about a public identity - properties: - id: - type: string - description: Identity id - example: 2c9180857182305e0171993735622948 - name: - type: string - description: Human-readable display name of identity. - example: Alison Ferguso - alias: - type: string - description: Alternate unique identifier for the identity. - example: alison.ferguso - email: - nullable: true - type: string - description: Email address of identity. - example: alison.ferguso@acme-solar.com - status: - nullable: true - type: string - description: The lifecycle status for the identity - example: Active - manager: - description: An identity reference to the manager of this identity - type: object - nullable: true - properties: - type: - example: IDENTITY - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - attributes: - type: array - description: The public identity attributes of the identity - items: - type: object - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: Human-readable display name of the attribute - example: Country - value: - type: string - description: The attribute value - example: US - example: - - id: 2c9180857182305e0171993735622948 - name: Alison Ferguso - alias: alison.ferguso - email: alison.ferguso@acme-solar.com - status: Active - manager: - type: IDENTITY - id: 2c9180a46faadee4016fb4e018c20639 - name: Thomas Edison - attributes: - - key: phone - name: Phone - value: '5125551234' - - key: country - name: Country - value: US - - id: 2c9180a46faadee4016fb4e018c20639 - name: Thomas Edison - alias: thomas.edison - email: thomas.edison@acme-solar.com - status: Active - manager: - type: IDENTITY - id: 2c918086676d3e0601677611dbde220f - name: Mister Manager - attributes: - - key: phone - name: Phone - value: '5125554321' - - key: country - name: Country - value: US - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /public-identities-config: - get: - operationId: getPublicIdentityConfig - tags: - - Public Identities Config - summary: Get the Public Identities Configuration - description: Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API. - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - properties: - attributes: - type: array - description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - items: - type: object - description: Used to map an attribute key for an Identity to its display name. - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: The attribute display name - example: Country - modified: - nullable: true - type: string - description: When this configuration was last modified. - format: date-time - example: '2018-06-25T20:22:28.104Z' - modifiedBy: - description: The identity who last modified this configuration. - type: object - nullable: true - properties: - type: - example: IDENTITY - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: updatePublicIdentityConfig - tags: - - Public Identities Config - summary: Update the Public Identities Configuration - description: Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API. - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - properties: - attributes: - type: array - description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - items: - type: object - description: Used to map an attribute key for an Identity to its display name. - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: The attribute display name - example: Country - modified: - nullable: true - type: string - description: When this configuration was last modified. - format: date-time - example: '2018-06-25T20:22:28.104Z' - modifiedBy: - description: The identity who last modified this configuration. - type: object - nullable: true - properties: - type: - example: IDENTITY - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - properties: - attributes: - type: array - description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - items: - type: object - description: Used to map an attribute key for an Identity to its display name. - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: The attribute display name - example: Country - modified: - nullable: true - type: string - description: When this configuration was last modified. - format: date-time - example: '2018-06-25T20:22:28.104Z' - modifiedBy: - description: The identity who last modified this configuration. - type: object - nullable: true - properties: - type: - example: IDENTITY - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /requestable-objects: - get: - operationId: listRequestableObjects - tags: - - Requestable Objects - summary: Requestable Objects List - description: |- - This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. - Any authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity. - parameters: - - in: query - name: identity-id - required: false - schema: - type: string - example: e7eab60924f64aa284175b9fa3309599 - description: |- - If present, the value returns only requestable objects for the specified identity. - * Admin users can call this with any identity ID value. - * Non-admin users can only specify *me* or pass their own identity ID value. - * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - - in: query - name: types - description: 'Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.' - required: false - schema: - type: array - items: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice. - example: ACCESS_PROFILE - example: 'ROLE,ACCESS_PROFILE' - explode: false - - in: query - name: term - required: false - schema: - type: string - example: Finance Role - description: 'It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored.' - - in: query - name: statuses - description: 'Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.' - required: false - schema: - type: array - items: - type: string - enum: - - AVAILABLE - - PENDING - - ASSIGNED - description: 'Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.' - explode: false - example: - - ASSIGNED - - PENDING - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - example: name sw "bob" - description: | - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, sw* - - in: query - name: sorters - schema: - type: string - format: comma-separated - example: name - description: | - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - responses: - '200': - description: List of requestable objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the requestable object itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Human-readable display name of the requestable object - example: Applied Research Access - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - nullable: true - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: Description of the requestable object. - example: 'Access to research information, lab results, and schematics.' - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice. - example: ACCESS_PROFILE - requestStatus: - type: string - enum: - - AVAILABLE - - PENDING - - ASSIGNED - description: 'Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.' - identityRequestId: - type: string - description: 'If *requestStatus* is *PENDING*, indicates the id of the associated account activity.' - nullable: true - example: null - ownerRef: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - requestCommentsRequired: - type: boolean - description: Whether the requester must provide comments when requesting the object. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /saved-searches: - post: - tags: - - Saved Search - description: | - Creates a new saved search. - summary: Create a saved search - operationId: savedSearchCreate - requestBody: - description: The saved search to persist. - content: - application/json: - schema: - allOf: - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - header: - description: | - The value of the header. - type: string - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: email - header: Work Email - - field: attributes.cloudLifecycleState - header: Lifecycle State - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - - query - required: true - responses: - '201': - description: The persisted saved search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - header: - description: | - The value of the header. - type: string - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: email - header: Work Email - - field: attributes.cloudLifecycleState - header: Lifecycle State - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - - query - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - get: - tags: - - Saved Search - description: | - Returns a list of saved searches. - summary: Return a list of Saved Searches - operationId: savedSearchList - parameters: - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - name: filters - in: query - schema: - type: string - description: | - An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results). - - Allowed filter properties: *owner.id*, *public* - - Allowed filter operator: *eq* - - **Example filters**: - - ```owner.id eq "0de46054-fe90-434a-b84e-c6b3359d0c64"``` -- returns saved searches for the specified owner ID - - ```public eq true``` -- returns all public saved searches - - ```owner.id eq me or public eq true``` -- returns all of the current user's saved searches as well as all public saved searches belonging to other users in the current org - responses: - '200': - description: The list of requested saved searches. - content: - application/json: - schema: - type: array - items: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - header: - description: | - The value of the header. - type: string - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: email - header: Work Email - - field: attributes.cloudLifecycleState - header: Lifecycle State - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - - query - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '/saved-searches/{id}': - put: - tags: - - Saved Search - description: | - Updates an existing saved search. - summary: | - Updates an existing saved search - operationId: savedSearchUpdate - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - requestBody: - description: The saved search to persist. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - header: - description: | - The value of the header. - type: string - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: email - header: Work Email - - field: attributes.cloudLifecycleState - header: Lifecycle State - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - - query - required: true - responses: - '200': - description: The persisted saved search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - header: - description: | - The value of the header. - type: string - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: email - header: Work Email - - field: attributes.cloudLifecycleState - header: Lifecycle State - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - - query - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - get: - tags: - - Saved Search - description: | - Returns the specified saved search. - summary: Return a saved search by ID - operationId: savedSearchGet - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - responses: - '200': - description: The requested saved search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - header: - description: | - The value of the header. - type: string - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: email - header: Work Email - - field: attributes.cloudLifecycleState - header: Lifecycle State - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - - query - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - delete: - tags: - - Saved Search - description: | - Deletes the specified saved search. - summary: Delete a document by ID - operationId: savedSearchDelete - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '/saved-searches/{id}/execute': - post: - tags: - - Saved Search - description: | - Executes the specified saved search. - summary: Execute a saved search by ID - operationId: savedSearchExecute - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - requestBody: - description: | - When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. - - If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - content: - application/json: - schema: - type: object - properties: - scheduleId: - description: | - The ID of the scheduled search that triggered the saved search execution. - type: string - example: 7a724640-0c17-4ce9-a8c3-4a89738459c8 - owner: - description: | - The owner of the scheduled search being tested. - allOf: - - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - recipients: - description: | - The email recipients of the scheduled search being tested. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - examples: - scheduled: - summary: Triggered by Scheduled Search - value: - scheduleId: 7a724640-0c17-4ce9-a8c3-4a89738459c8 - test: - summary: Triggered by UI Test - value: - owner: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - recipients: - - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - required: true - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /scheduled-searches: - post: - tags: - - Scheduled Search - description: | - Creates a new scheduled search. - summary: Create a new scheduled search - operationId: scheduledSearchCreate - requestBody: - description: The scheduled search to persist. - content: - application/json: - schema: - allOf: - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - description: - description: | - The description of the scheduled search. - type: string - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: | - The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - description: | - The date the scheduled search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the scheduled search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - schedule: - type: object - description: | - The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - months: - description: The months selected. - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - days: - description: | - The days selected. - example: - type: LIST - values: - - MON - - WED - - FRI - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - hours: - description: | - The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - expiration: - description: | - The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: | - The ID of the time zone for the schedule. - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: | - The email recipients. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - required: - - savedSearchId - - schedule - - recipients - required: true - responses: - '201': - description: The persisted scheduled search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - description: - description: | - The description of the scheduled search. - type: string - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: | - The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - description: | - The date the scheduled search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the scheduled search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - schedule: - type: object - description: | - The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - months: - description: The months selected. - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - days: - description: | - The days selected. - example: - type: LIST - values: - - MON - - WED - - FRI - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - hours: - description: | - The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - expiration: - description: | - The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: | - The ID of the time zone for the schedule. - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: | - The email recipients. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - required: - - savedSearchId - - schedule - - recipients - - type: object - properties: - id: - description: | - The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the scheduled search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - ownerId: - description: The ID of the scheduled search owner - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - get: - tags: - - Scheduled Search - description: | - Returns a list of scheduled searches. - summary: Return a list of scheduled searches - operationId: scheduledSearchList - parameters: - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - name: filters - in: query - schema: - type: string - description: | - An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results). - - Allowed filter properties: *owner.id*, *savedSearchId* - - Allowed filter operator: *eq* - - **Example filters**: - - ```owner.id eq "0de46054-fe90-434a-b84e-c6b3359d0c64"``` -- returns scheduled searches for the specified owner ID - - ```savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"``` -- returns scheduled searches that reference the specified saved search - - ```owner.id eq me or savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"``` -- returns all of the current user's scheduled searches as well as all scheduled searches that reference the specified saved search - responses: - '200': - description: The list of requested scheduled searches. - content: - application/json: - schema: - type: array - items: - type: object - allOf: - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - description: - description: | - The description of the scheduled search. - type: string - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: | - The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - description: | - The date the scheduled search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the scheduled search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - schedule: - type: object - description: | - The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - months: - description: The months selected. - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - days: - description: | - The days selected. - example: - type: LIST - values: - - MON - - WED - - FRI - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - hours: - description: | - The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - expiration: - description: | - The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: | - The ID of the time zone for the schedule. - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: | - The email recipients. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - required: - - savedSearchId - - schedule - - recipients - - type: object - properties: - id: - description: | - The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the scheduled search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - ownerId: - description: The ID of the scheduled search owner - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '/scheduled-searches/{id}': - put: - tags: - - Scheduled Search - description: | - Updates an existing scheduled search. - summary: Update an existing Scheduled Search - operationId: scheduledSearchUpdate - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - requestBody: - description: The scheduled search to persist. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - description: - description: | - The description of the scheduled search. - type: string - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: | - The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - description: | - The date the scheduled search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the scheduled search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - schedule: - type: object - description: | - The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - months: - description: The months selected. - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - days: - description: | - The days selected. - example: - type: LIST - values: - - MON - - WED - - FRI - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - hours: - description: | - The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - expiration: - description: | - The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: | - The ID of the time zone for the schedule. - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: | - The email recipients. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - required: - - savedSearchId - - schedule - - recipients - - type: object - properties: - id: - description: | - The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the scheduled search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - ownerId: - description: The ID of the scheduled search owner - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - required: true - responses: - '200': - description: The persisted scheduled search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - description: - description: | - The description of the scheduled search. - type: string - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: | - The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - description: | - The date the scheduled search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the scheduled search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - schedule: - type: object - description: | - The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - months: - description: The months selected. - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - days: - description: | - The days selected. - example: - type: LIST - values: - - MON - - WED - - FRI - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - hours: - description: | - The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - expiration: - description: | - The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: | - The ID of the time zone for the schedule. - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: | - The email recipients. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - required: - - savedSearchId - - schedule - - recipients - - type: object - properties: - id: - description: | - The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the scheduled search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - ownerId: - description: The ID of the scheduled search owner - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - get: - tags: - - Scheduled Search - description: | - Returns the specified scheduled search. - summary: Return a Scheduled Search by ID - operationId: scheduledSearchGet - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - responses: - '200': - description: The requested scheduled search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - description: - description: | - The description of the scheduled search. - type: string - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: | - The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - description: | - The date the scheduled search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the scheduled search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - schedule: - type: object - description: | - The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - months: - description: The months selected. - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - days: - description: | - The days selected. - example: - type: LIST - values: - - MON - - WED - - FRI - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - hours: - description: | - The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - expiration: - description: | - The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: | - The ID of the time zone for the schedule. - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: | - The email recipients. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - required: - - savedSearchId - - schedule - - recipients - - type: object - properties: - id: - description: | - The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the scheduled search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - ownerId: - description: The ID of the scheduled search owner - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - delete: - tags: - - Scheduled Search - description: | - Deletes the specified scheduled search. - operationId: scheduledSearchDelete - summary: Delete a Scheduled Search by ID - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '/scheduled-searches/{id}/unsubscribe': - post: - tags: - - Scheduled Search - description: | - Unsubscribes a recipient from the specified scheduled search. - operationId: scheduledSearchUnsubscribe - summary: Unsubscribe a recipient from Scheduled Search - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - requestBody: - description: | - The recipient to be removed from the scheduled search. - content: - application/json: - schema: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - required: true - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - /search: - post: - tags: - - Search - description: Performs a search with the provided query and returns a matching result collection. - externalDocs: - description: Learn more about search. - url: 'https://documentation.sailpoint.com/saas/help/search/index.html' - operationId: searchPost - summary: Perform Search - parameters: - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - requestBody: - content: - application/json: - schema: - type: object - properties: - indices: - description: The names of the Elasticsearch indices in which to search. - externalDocs: - description: Learn more about search indices here. - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - queryType: - description: |- - The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. - To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - - TYPEAHEAD - default: SAILPOINT - example: SAILPOINT - queryVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - - type: string - description: |- - The version of the query object. - This version number will map to the version of Elasticsearch for the query strings and objects being used. - query: - type: object - description: Query parameters used to construct an Elasticsearch query object. - properties: - query: - description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'name:a*' - fields: - description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. - type: array - items: - type: string - example: - - name - timeZone: - description: The time zone to be applied to any range query related to dates. - type: string - example: America/Chicago - innerHit: - description: The innerHit query object returns a flattened list of results for the specified nested type. - type: object - required: - - query - - type - properties: - query: - description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'source.name:\"Active Directory\"' - type: - description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' - type: string - example: access - queryDsl: - description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' - type: object - example: - match: - name: john.doe - typeAheadQuery: - type: object - description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' - required: - - query - - field - properties: - query: - description: The type ahead query string used to construct a phrase prefix match query. - type: string - example: Work - field: - description: The field on which to perform the type ahead search. - type: string - example: source.name - nestedType: - description: The nested type. - type: string - example: access - maxExpansions: - description: |- - The number of suffixes the last term will be expanded into. - Influences the performance of the query and the number results returned. - Valid values: 1 to 1000. - type: integer - format: int32 - minimum: 1 - maximum: 1000 - default: 10 - example: 10 - includeNested: - description: Indicates whether nested objects from returned search results should be included. - type: boolean - default: true - example: true - queryResultFilter: - type: object - description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - properties: - includes: - description: The list of field names to include in the result documents. - type: array - items: - type: string - example: - - name - - displayName - excludes: - description: The list of field names to exclude from the result documents. - type: array - items: - type: string - example: - - stacktrace - aggregationType: - description: | - Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. - - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - default: DSL - example: DSL - aggregationsVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - - type: string - description: |- - The version of the language being used for aggregation queries. - This version number will map to the version of Elasticsearch for the aggregation query object. - aggregationsDsl: - description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' - type: object - aggregations: - description: | - The aggregation’s specifications, such as the groupings and calculations to be performed. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: - type: string - example: +id - searchAfter: - description: |- - Used to begin the search window at the values specified. - This parameter consists of the last values of the sorted fields in the current record set. - This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. - For example, when searching for identities, if the last idenitity ID in the search result is 2c91808375d8e80a0175e1f88a575221, then using that ID in this property will start a new search after this identity. - type: array - items: - type: string - example: 2c91808375d8e80a0175e1f88a575221 - filters: - description: The filters to be applied for each filtered field name. - type: object - additionalProperties: - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - examples: - query-fields: - summary: Query with Fields - value: - indices: - - identities - query: - query: '"John Doe"' - fields: - - name - query-timeZone: - summary: Query with TimeZone - value: - indices: - - identities - query: - query: 'created: [2022-05-19T19:26:03.351Z TO now]' - timeZone: America/Los_Angeles - query-innerHit: - summary: Query with InnerHit - value: - indices: - - identities - query: - query: '"John Doe"' - innerHit: - type: access - query: 'source.name:\"Active Directory\"' - typeAheadQuery: - summary: TypeAheadQuery - value: - indices: - - identities - queryType: TYPEAHEAD - typeAheadQuery: - field: name - query: Jo - maxExpansions: 50 - typeAheadQuery-nestedType: - summary: TypeAheadQuery with NestedType - value: - indices: - - identities - queryType: TYPEAHEAD - typeAheadQuery: - field: source.name - nestedType: access - query: Work - maxExpansions: 50 - filter-exists: - summary: Filter with Exists - value: - indices: - - identities - query: - query: 'attributes.city:London' - filters: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - filter-range: - summary: Filter with Range - value: - indices: - - identities - query: - query: 'attributes.city:London' - timeZone: Europe/London - filters: - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - filter-terms: - summary: Filter with Terms - value: - indices: - - identities - query: - query: 'attributes.city:London' - filters: - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - required: true - responses: - '200': - description: List of matching documents. - content: - application/json: - schema: - type: array - items: - discriminator: - propertyName: _type - mapping: - accessprofile: ../model/access/profile/AccessProfile.yaml - accountactivity: ../model/account/activity/AccountActivity.yaml - account: ../model/account/Account.yaml - aggregation: ../model/aggregation/Aggregation.yaml - entitlement: ../model/entitlement/Entitlement.yaml - event: ../model/event/Event.yaml - identity: ../model/identity/Identity.yaml - role: ../model/role/Role.yaml - oneOf: - - description: 'This is more of a complete representation of an access profile. ' - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - entitlementCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: AccountActivity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - action: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - origin: - type: string - status: - type: string - requester: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - recipient: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - trackingNumber: - type: string - errors: - type: array - items: - type: string - warnings: - type: array - items: - type: string - approvals: - type: array - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - commenter: - type: string - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: string - type: - type: string - originalRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - expansionItems: - type: array - items: - type: object - properties: - accountId: - type: string - cause: - type: string - name: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - accountRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - provisioningTarget: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: object - properties: - errors: - type: array - items: - type: string - status: - type: string - ticketId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - sources: - type: array - items: - type: string - - description: Account - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - attributes: - type: object - description: a map or dictionary of key/value pairs - identity: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - access: - type: array - items: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - entitlementCount: - type: integer - uncorrelated: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Aggregation - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - status: - type: string - duration: - type: integer - avgDuration: - type: integer - changedAccounts: - type: integer - nextScheduled: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - startTime: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - sourceOwner: - type: string - - description: Entitlement - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - displayName: - type: string - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - identityCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Event - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - action: - type: string - type: - type: string - actor: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - target: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - stack: - type: string - trackingNumber: - type: string - ipAddress: - type: string - details: - type: string - attributes: - type: object - objects: - type: array - items: - type: string - operation: - type: string - status: - type: string - technicalName: - type: string - - description: Identity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - firstName: - type: string - lastName: - type: string - displayName: - type: string - email: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - phone: - type: string - inactive: - type: boolean - protected: - type: boolean - status: - type: string - employeeNumber: - type: string - manager: - nullable: true - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - isManager: - type: boolean - identityProfile: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - attributes: - type: object - description: a map or dictionary of key/value pairs - processingState: - type: string - nullable: true - processingDetails: - nullable: true - type: object - properties: - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - retryCount: - type: integer - stackTrace: - type: string - message: - type: string - accounts: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - accountCount: - type: integer - apps: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - account: - type: object - properties: - id: - type: string - accountId: - type: string - appCount: - type: integer - access: - type: array - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfile.yaml - ENTITLEMENT: ../access/Entitlement.yaml - ROLE: ../access/Role.yaml - oneOf: - - description: 'This is a summary representation of an access profile. ' - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - accessProfileCount: - type: integer - entitlementCount: - type: integer - roleCount: - type: integer - owns: - type: object - properties: - sources: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - roles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - apps: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - governanceGroups: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - fallbackApprover: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Role - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfileCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - examples: - accessProfiles: - summary: A collection of AccessProfiles - 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' - 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 - tags: - - TAG_1 - - TAG_2 - 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 - privileged: false - identityCount: 68 - tags: - - TAG_1 - - TAG_2 - events: - 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 - target: - name: Perform provisioning activity search delete synchronization - stack: tpe - trackingNumber: c6b98bc39ece48b080826d16c76b166c - ipAddress: 207.189.160.158 - details: 'null' - attributes: - sourceName: SailPoint - objects: - - TASK - - SCHEDULE - operation: UPDATE - status: PASSED - technicalName: TASK_SCHEDULE_UPDATE_PASSED - identities: - 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 - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: O349804 - manager: null - isManager: false - identityProfile: - id: 2c918085605c8d0601606f357cb231e6 - name: E2E AD - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - 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 - 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: null - created: '2018-08-22T19:54:54.302Z' - accountCount: 2 - 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 - 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 - tags: - - TAG_1 - - TAG_2 - roles: - 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' - enabled: true - requestable: false - requestCommentsRequired: false - owner: - id: 2c9180a46faadee4016fb4e018c20639 - name: Cloud Support - type: IDENTITY - email: thomas.edison@acme-solar.com - accessProfiles: - - id: 2c91809c6faade77016fb4f0b63407ae - name: Admin Access - accessProfileCount: 1 - tags: - - TAG_1 - - TAG_2 - headers: - X-Total-Count: - schema: - type: integer - description: The total result count (returned only if the *count* parameter is specified as *true*). - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /search/count: - post: - tags: - - Search - description: Performs a search with provided query and returns count of results in the X-Total-Count header. - operationId: searchCount - summary: Count the number of Documents satisfying a Query - requestBody: - content: - application/json: - schema: - type: object - properties: - indices: - description: The names of the Elasticsearch indices in which to search. - externalDocs: - description: Learn more about search indices here. - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - queryType: - description: |- - The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. - To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - - TYPEAHEAD - default: SAILPOINT - example: SAILPOINT - queryVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - - type: string - description: |- - The version of the query object. - This version number will map to the version of Elasticsearch for the query strings and objects being used. - query: - type: object - description: Query parameters used to construct an Elasticsearch query object. - properties: - query: - description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'name:a*' - fields: - description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. - type: array - items: - type: string - example: - - name - timeZone: - description: The time zone to be applied to any range query related to dates. - type: string - example: America/Chicago - innerHit: - description: The innerHit query object returns a flattened list of results for the specified nested type. - type: object - required: - - query - - type - properties: - query: - description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'source.name:\"Active Directory\"' - type: - description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' - type: string - example: access - queryDsl: - description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' - type: object - example: - match: - name: john.doe - typeAheadQuery: - type: object - description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' - required: - - query - - field - properties: - query: - description: The type ahead query string used to construct a phrase prefix match query. - type: string - example: Work - field: - description: The field on which to perform the type ahead search. - type: string - example: source.name - nestedType: - description: The nested type. - type: string - example: access - maxExpansions: - description: |- - The number of suffixes the last term will be expanded into. - Influences the performance of the query and the number results returned. - Valid values: 1 to 1000. - type: integer - format: int32 - minimum: 1 - maximum: 1000 - default: 10 - example: 10 - includeNested: - description: Indicates whether nested objects from returned search results should be included. - type: boolean - default: true - example: true - queryResultFilter: - type: object - description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - properties: - includes: - description: The list of field names to include in the result documents. - type: array - items: - type: string - example: - - name - - displayName - excludes: - description: The list of field names to exclude from the result documents. - type: array - items: - type: string - example: - - stacktrace - aggregationType: - description: | - Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. - - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - default: DSL - example: DSL - aggregationsVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - - type: string - description: |- - The version of the language being used for aggregation queries. - This version number will map to the version of Elasticsearch for the aggregation query object. - aggregationsDsl: - description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' - type: object - aggregations: - description: | - The aggregation’s specifications, such as the groupings and calculations to be performed. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: - type: string - example: +id - searchAfter: - description: |- - Used to begin the search window at the values specified. - This parameter consists of the last values of the sorted fields in the current record set. - This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. - For example, when searching for identities, if the last idenitity ID in the search result is 2c91808375d8e80a0175e1f88a575221, then using that ID in this property will start a new search after this identity. - type: array - items: - type: string - example: 2c91808375d8e80a0175e1f88a575221 - filters: - description: The filters to be applied for each filtered field name. - type: object - additionalProperties: - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - examples: - query-timeZone: - summary: Query with TimeZone - value: - indices: - - identities - query: - query: 'created: [2022-05-19T19:26:03.351Z TO now]' - timeZone: America/Los_Angeles - required: true - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - headers: - X-Total-Count: - description: The total result count. - schema: - type: integer - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - /search/aggregate: - post: - tags: - - Search - description: Performs a search query aggregation and returns aggregation result. - operationId: searchAggregate - summary: Perform a Search Query Aggregation - parameters: - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - requestBody: - content: - application/json: - schema: - type: object - properties: - indices: - description: The names of the Elasticsearch indices in which to search. - externalDocs: - description: Learn more about search indices here. - url: 'https://documentation.sailpoint.com/saas/help/search/searchable-fields.html' - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - queryType: - description: |- - The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. - To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - - TYPEAHEAD - default: SAILPOINT - example: SAILPOINT - queryVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - - type: string - description: |- - The version of the query object. - This version number will map to the version of Elasticsearch for the query strings and objects being used. - query: - type: object - description: Query parameters used to construct an Elasticsearch query object. - properties: - query: - description: 'The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'name:a*' - fields: - description: The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields. - type: array - items: - type: string - example: - - name - timeZone: - description: The time zone to be applied to any range query related to dates. - type: string - example: America/Chicago - innerHit: - description: The innerHit query object returns a flattened list of results for the specified nested type. - type: object - required: - - query - - type - properties: - query: - description: 'The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.' - type: string - example: 'source.name:\"Active Directory\"' - type: - description: 'The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.' - type: string - example: access - queryDsl: - description: 'The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.' - type: object - example: - match: - name: john.doe - typeAheadQuery: - type: object - description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' - required: - - query - - field - properties: - query: - description: The type ahead query string used to construct a phrase prefix match query. - type: string - example: Work - field: - description: The field on which to perform the type ahead search. - type: string - example: source.name - nestedType: - description: The nested type. - type: string - example: access - maxExpansions: - description: |- - The number of suffixes the last term will be expanded into. - Influences the performance of the query and the number results returned. - Valid values: 1 to 1000. - type: integer - format: int32 - minimum: 1 - maximum: 1000 - default: 10 - example: 10 - includeNested: - description: Indicates whether nested objects from returned search results should be included. - type: boolean - default: true - example: true - queryResultFilter: - type: object - description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - properties: - includes: - description: The list of field names to include in the result documents. - type: array - items: - type: string - example: - - name - - displayName - excludes: - description: The list of field names to exclude from the result documents. - type: array - items: - type: string - example: - - stacktrace - aggregationType: - description: | - Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. - - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - default: DSL - example: DSL - aggregationsVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - - type: string - description: |- - The version of the language being used for aggregation queries. - This version number will map to the version of Elasticsearch for the aggregation query object. - aggregationsDsl: - description: 'The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.' - type: object - aggregations: - description: | - The aggregation’s specifications, such as the groupings and calculations to be performed. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: - type: string - example: +id - searchAfter: - description: |- - Used to begin the search window at the values specified. - This parameter consists of the last values of the sorted fields in the current record set. - This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. - For example, when searching for identities, if the last idenitity ID in the search result is 2c91808375d8e80a0175e1f88a575221, then using that ID in this property will start a new search after this identity. - type: array - items: - type: string - example: 2c91808375d8e80a0175e1f88a575221 - filters: - description: The filters to be applied for each filtered field name. - type: object - additionalProperties: - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - examples: - metricAggregation: - summary: MetricAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - metric: - name: How Many Locations - type: UNIQUE_COUNT - field: attributes.city - metricAggregation-dsl: - summary: MetricAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - How Many Locations: - cardinality: - field: attributes.city.exact - bucketAggregation: - summary: BucketAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - bucket: - name: Identity Locations - type: TERMS - field: attributes.city - bucketAggregation-dsl: - summary: BucketAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - Identity Locations: - terms: - field: attributes.city.exact - nestedAggregation-bucketAggregation: - summary: NestedAggregation with BucketAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - nested: - name: Access - field: access - type: TERMS - bucket: - name: Access Source Name - type: TERMS - field: access.source.name - nestedAggregation-bucketAggregation-dsl: - summary: NestedAggregation with BucketAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - access: - nested: - path: access - aggs: - Access Source Name: - terms: - field: access.source.name.exact - nestedAggregation-filterAggregation-bucketAggregation: - summary: NestedAggregation with FilterAggregation and BucketAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - nested: - name: Access - field: access - type: TERMS - filter: - name: Entitlements - field: access.type - value: ENTITLEMENT - bucket: - name: Access Name - type: TERMS - field: access.name - nestedAggregation-filterAggregation-bucketAggregation-dsl: - summary: NestedAggregation with FilterAggregation and BucketAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - access: - nested: - path: access - aggs: - Entitlements: - filter: - term: - access.type: ENTITLEMENT - aggs: - Access Name: - terms: - field: access.name.exact - bucketAggregation-subAggregation: - summary: BucketAggregation with SubAggregation - value: - indices: - - aggregations - aggregationType: SAILPOINT - aggregations: - bucket: - name: Identity Department - type: TERMS - field: attributes.department - subAggregation: - bucket: - name: Identity Locations - type: TERMS - field: attributes.city - bucketAggregation-subAggregation-dsl: - summary: BucketAggregation with SubAggregation using DSL - value: - indices: - - aggregations - aggregationType: DSL - aggregationsDsl: - Identity Department: - terms: - field: attributes.department.exact - aggs: - Identity Locations: - terms: - field: attributes.city.exact - required: true - responses: - '200': - description: Aggregation results. - content: - application/json: - schema: - type: object - properties: - aggregations: - type: object - description: | - The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. - - See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. - example: - Identity Locations: - buckets: - - key: Austin - doc_count: 109 - - key: London - doc_count: 64 - - key: San Jose - doc_count: 27 - - key: Brussels - doc_count: 26 - - key: Sao Paulo - doc_count: 24 - - key: Munich - doc_count: 23 - - key: Singapore - doc_count: 22 - - key: Tokyo - doc_count: 20 - - key: Taipei - doc_count: 16 - hits: - description: | - The results of the aggregation search query. - type: array - items: - discriminator: - propertyName: _type - mapping: - accessprofile: ../model/access/profile/AccessProfile.yaml - accountactivity: ../model/account/activity/AccountActivity.yaml - account: ../model/account/Account.yaml - aggregation: ../model/aggregation/Aggregation.yaml - entitlement: ../model/entitlement/Entitlement.yaml - event: ../model/event/Event.yaml - identity: ../model/identity/Identity.yaml - role: ../model/role/Role.yaml - oneOf: - - description: 'This is more of a complete representation of an access profile. ' - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - entitlementCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: AccountActivity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - action: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - origin: - type: string - status: - type: string - requester: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - recipient: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - trackingNumber: - type: string - errors: - type: array - items: - type: string - warnings: - type: array - items: - type: string - approvals: - type: array - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - commenter: - type: string - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: string - type: - type: string - originalRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - expansionItems: - type: array - items: - type: object - properties: - accountId: - type: string - cause: - type: string - name: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - accountRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - provisioningTarget: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: object - properties: - errors: - type: array - items: - type: string - status: - type: string - ticketId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - sources: - type: array - items: - type: string - - description: Account - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - attributes: - type: object - description: a map or dictionary of key/value pairs - identity: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - access: - type: array - items: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - entitlementCount: - type: integer - uncorrelated: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Aggregation - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - status: - type: string - duration: - type: integer - avgDuration: - type: integer - changedAccounts: - type: integer - nextScheduled: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - startTime: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - sourceOwner: - type: string - - description: Entitlement - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - displayName: - type: string - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - identityCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Event - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - action: - type: string - type: - type: string - actor: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - target: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - stack: - type: string - trackingNumber: - type: string - ipAddress: - type: string - details: - type: string - attributes: - type: object - objects: - type: array - items: - type: string - operation: - type: string - status: - type: string - technicalName: - type: string - - description: Identity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - firstName: - type: string - lastName: - type: string - displayName: - type: string - email: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - phone: - type: string - inactive: - type: boolean - protected: - type: boolean - status: - type: string - employeeNumber: - type: string - manager: - nullable: true - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - isManager: - type: boolean - identityProfile: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - attributes: - type: object - description: a map or dictionary of key/value pairs - processingState: - type: string - nullable: true - processingDetails: - nullable: true - type: object - properties: - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - retryCount: - type: integer - stackTrace: - type: string - message: - type: string - accounts: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - accountCount: - type: integer - apps: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - account: - type: object - properties: - id: - type: string - accountId: - type: string - appCount: - type: integer - access: - type: array - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfile.yaml - ENTITLEMENT: ../access/Entitlement.yaml - ROLE: ../access/Role.yaml - oneOf: - - description: 'This is a summary representation of an access profile. ' - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - accessProfileCount: - type: integer - entitlementCount: - type: integer - roleCount: - type: integer - owns: - type: object - properties: - sources: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - roles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - apps: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - governanceGroups: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - fallbackApprover: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Role - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfileCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - text/csv: - schema: - description: | - If the *Accept:text/csv* header is specified and the *aggregationType* parameter in the request body is *SAILPOINT*, - - the aggregation result will be returned as a CSV document. - type: string - example: - - 'Identity Locations,Count' - - 'Munich,23' - - 'Brussels,26' - - 'Singapore,22' - - 'Tokyo,20' - - 'Taipei,16' - - 'London,64' - - 'Austin,109' - - 'Sao Paulo,24' - - 'San Jose,27' - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '/search/{index}/{id}': - get: - tags: - - Search - description: Fetches a single document from the specified index using the specified document ID. - operationId: searchGet - summary: Get a Document by ID - parameters: - - in: path - name: index - description: | - The index from which to fetch the specified document. - - The currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*. - schema: - type: string - required: true - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - responses: - '200': - description: The requested document. - content: - application/json: - schema: - discriminator: - propertyName: _type - mapping: - accessprofile: ../model/access/profile/AccessProfile.yaml - accountactivity: ../model/account/activity/AccountActivity.yaml - account: ../model/account/Account.yaml - aggregation: ../model/aggregation/Aggregation.yaml - entitlement: ../model/entitlement/Entitlement.yaml - event: ../model/event/Event.yaml - identity: ../model/identity/Identity.yaml - role: ../model/role/Role.yaml - oneOf: - - description: 'This is more of a complete representation of an access profile. ' - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - entitlementCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: AccountActivity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - action: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - origin: - type: string - status: - type: string - requester: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - recipient: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - trackingNumber: - type: string - errors: - type: array - items: - type: string - warnings: - type: array - items: - type: string - approvals: - type: array - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - commenter: - type: string - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: string - type: - type: string - originalRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - expansionItems: - type: array - items: - type: object - properties: - accountId: - type: string - cause: - type: string - name: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - accountRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - provisioningTarget: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: object - properties: - errors: - type: array - items: - type: string - status: - type: string - ticketId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - sources: - type: array - items: - type: string - - description: Account - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - attributes: - type: object - description: a map or dictionary of key/value pairs - identity: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - access: - type: array - items: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - entitlementCount: - type: integer - uncorrelated: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Aggregation - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - status: - type: string - duration: - type: integer - avgDuration: - type: integer - changedAccounts: - type: integer - nextScheduled: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - startTime: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - sourceOwner: - type: string - - description: Entitlement - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - displayName: - type: string - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - identityCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Event - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - action: - type: string - type: - type: string - actor: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - target: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - stack: - type: string - trackingNumber: - type: string - ipAddress: - type: string - details: - type: string - attributes: - type: object - objects: - type: array - items: - type: string - operation: - type: string - status: - type: string - technicalName: - type: string - - description: Identity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - firstName: - type: string - lastName: - type: string - displayName: - type: string - email: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - phone: - type: string - inactive: - type: boolean - protected: - type: boolean - status: - type: string - employeeNumber: - type: string - manager: - nullable: true - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - isManager: - type: boolean - identityProfile: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - attributes: - type: object - description: a map or dictionary of key/value pairs - processingState: - type: string - nullable: true - processingDetails: - nullable: true - type: object - properties: - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - retryCount: - type: integer - stackTrace: - type: string - message: - type: string - accounts: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - accountCount: - type: integer - apps: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - account: - type: object - properties: - id: - type: string - accountId: - type: string - appCount: - type: integer - access: - type: array - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfile.yaml - ENTITLEMENT: ../access/Entitlement.yaml - ROLE: ../access/Role.yaml - oneOf: - - description: 'This is a summary representation of an access profile. ' - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - accessProfileCount: - type: integer - entitlementCount: - type: integer - roleCount: - type: integer - owns: - type: object - properties: - sources: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - roles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - apps: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - governanceGroups: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - fallbackApprover: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Role - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfileCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - examples: - accessProfile: - summary: AccessProfile - 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' - 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 - tags: - - TAG_1 - - TAG_2 - entitlement: - summary: Entitlement - 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 - privileged: false - identityCount: 68 - tags: - - TAG_1 - - TAG_2 - event: - summary: Event - 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 - target: - name: Perform provisioning activity search delete synchronization - stack: tpe - trackingNumber: c6b98bc39ece48b080826d16c76b166c - ipAddress: 207.189.160.158 - details: 'null' - attributes: - sourceName: SailPoint - objects: - - TASK - - SCHEDULE - operation: UPDATE - status: PASSED - technicalName: TASK_SCHEDULE_UPDATE_PASSED - identity: - summary: Identity - 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 - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: O349804 - manager: null - isManager: false - identityProfile: - id: 2c918085605c8d0601606f357cb231e6 - name: E2E AD - source: - id: 2c9180855c45b230015c46c19b9c0202 - name: EndToEnd-ADSource - 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 - 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: null - created: '2018-08-22T19:54:54.302Z' - accountCount: 2 - 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 - 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 - tags: - - TAG_1 - - TAG_2 - role: - summary: Role - 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' - enabled: true - requestable: false - requestCommentsRequired: false - owner: - id: 2c9180a46faadee4016fb4e018c20639 - name: Cloud Support - type: IDENTITY - email: thomas.edison@acme-solar.com - accessProfiles: - - id: 2c91809c6faade77016fb4f0b63407ae - name: Admin Access - accessProfileCount: 1 - tags: - - TAG_1 - - TAG_2 - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - /service-desk-integrations: - get: - tags: - - Service Desk Integration - summary: List existing Service Desk Integrations - description: Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getServiceDeskIntegrationList - parameters: - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - name: sorters - in: query - required: false - style: form - explode: true - schema: - type: string - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - - name: filters - in: query - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq* - - **type**: *eq, in* - - **cluster**: *eq, in* - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - responses: - '200': - description: List of ServiceDeskIntegrationDto - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: Type of the Service Desk integration - type: string - default: ServiceNowSDIM - ownerRef: - description: Reference to the identity that is the owner of this Service Desk integration - default: - type: IDENTITY - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - clusterRef: - description: Reference to the source cluster for this Service Desk integration - default: - type: CLUSTER - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - beforeProvisioningRule: - description: Reference to beforeProvisioningRule for this Service Desk integration - default: - type: RULE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - post: - tags: - - Service Desk Integration - summary: Create a new Service Desk integration - description: Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: createServiceDeskIntegration - requestBody: - description: The specifics of a new integration to create - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: Type of the Service Desk integration - type: string - default: ServiceNowSDIM - ownerRef: - description: Reference to the identity that is the owner of this Service Desk integration - default: - type: IDENTITY - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - clusterRef: - description: Reference to the source cluster for this Service Desk integration - default: - type: CLUSTER - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - beforeProvisioningRule: - description: Reference to beforeProvisioningRule for this Service Desk integration - default: - type: RULE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - required: true - responses: - '200': - description: details of the created integration - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: Type of the Service Desk integration - type: string - default: ServiceNowSDIM - ownerRef: - description: Reference to the identity that is the owner of this Service Desk integration - default: - type: IDENTITY - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - clusterRef: - description: Reference to the source cluster for this Service Desk integration - default: - type: CLUSTER - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - beforeProvisioningRule: - description: Reference to beforeProvisioningRule for this Service Desk integration - default: - type: RULE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:write' - - 'idn:service-desk-integration:write' - '/service-desk-integrations/{id}': - get: - tags: - - Service Desk Integration - summary: Get a Service Desk integration by ID - description: Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getServiceDeskIntegration - parameters: - - name: id - in: path - description: ID of the Service Desk integration to get - required: true - style: simple - explode: false - schema: - type: string - example: anId - responses: - '200': - description: ServiceDeskIntegrationDto with the given ID - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: Type of the Service Desk integration - type: string - default: ServiceNowSDIM - ownerRef: - description: Reference to the identity that is the owner of this Service Desk integration - default: - type: IDENTITY - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - clusterRef: - description: Reference to the source cluster for this Service Desk integration - default: - type: CLUSTER - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - beforeProvisioningRule: - description: Reference to beforeProvisioningRule for this Service Desk integration - default: - type: RULE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - put: - tags: - - Service Desk Integration - summary: Update a Service Desk integration by ID - description: Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: updateServiceDeskIntegration - parameters: - - name: id - in: path - description: ID of the Service Desk integration to update - required: true - style: simple - explode: false - schema: - type: string - example: anId - requestBody: - description: The specifics of the integration to update - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: Type of the Service Desk integration - type: string - default: ServiceNowSDIM - ownerRef: - description: Reference to the identity that is the owner of this Service Desk integration - default: - type: IDENTITY - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - clusterRef: - description: Reference to the source cluster for this Service Desk integration - default: - type: CLUSTER - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - beforeProvisioningRule: - description: Reference to beforeProvisioningRule for this Service Desk integration - default: - type: RULE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - required: true - responses: - '200': - description: ServiceDeskIntegrationDto as updated - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: Type of the Service Desk integration - type: string - default: ServiceNowSDIM - ownerRef: - description: Reference to the identity that is the owner of this Service Desk integration - default: - type: IDENTITY - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - clusterRef: - description: Reference to the source cluster for this Service Desk integration - default: - type: CLUSTER - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - beforeProvisioningRule: - description: Reference to beforeProvisioningRule for this Service Desk integration - default: - type: RULE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:write' - - 'idn:service-desk-integration:write' - delete: - tags: - - Service Desk Integration - summary: Delete a Service Desk integration by ID - description: Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: deleteServiceDeskIntegration - parameters: - - name: id - in: path - description: ID of Service Desk integration to delete - required: true - style: simple - explode: false - schema: - type: string - example: anId - responses: - '204': - description: Service Desk integration with the given ID successfully deleted - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:write' - - 'idn:service-desk-integration:write' - patch: - operationId: patchServiceDeskIntegration - tags: - - Service Desk Integration - summary: Service Desk Integration Update - PATCH - description: Update an existing ServiceDeskIntegration by ID with a PATCH request. - parameters: - - name: id - in: path - description: ID of the Service Desk integration to update - required: true - style: simple - explode: false - schema: - type: string - example: anId - requestBody: - required: true - description: | - A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - PATCH can only be applied to the following fields: - * "beforeProvisioningRule" - - A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. - content: - application/json-patch+json: - schema: - type: object - description: 'A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - properties: - operations: - description: Operations to be applied - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - example: "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - responses: - '200': - description: ServiceDeskIntegrationDto as updated - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: Type of the Service Desk integration - type: string - default: ServiceNowSDIM - ownerRef: - description: Reference to the identity that is the owner of this Service Desk integration - default: - type: IDENTITY - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - clusterRef: - description: Reference to the source cluster for this Service Desk integration - default: - type: CLUSTER - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - beforeProvisioningRule: - description: Reference to beforeProvisioningRule for this Service Desk integration - default: - type: RULE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:write' - - 'idn:service-desk-integration:write' - /service-desk-integrations/types: - get: - tags: - - Service Desk Integration - summary: Service Desk Integration Types List. - description: This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getServiceDeskIntegrationTypes - responses: - '200': - description: Responds with an array of the currently supported Service Desk integration types. - content: - application/json: - schema: - type: array - items: - description: This represents a Service Desk Integration template type. - required: - - type - - scriptName - type: object - properties: - name: - description: This is the name of the type. - example: aName - type: string - type: - description: This is the type value for the type. - example: aType - type: string - scriptName: - description: This is the scriptName attribute value for the type. - example: aScriptName - type: string - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - '/service-desk-integrations/templates/{scriptName}': - get: - tags: - - Service Desk Integration - summary: Service Desk integration template by scriptName. - description: This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getServiceDeskIntegrationTemplate - parameters: - - name: scriptName - in: path - description: The scriptName value of the Service Desk integration template to get - required: true - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '200': - description: Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. - content: - application/json: - schema: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: 'This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations.' - required: - - type - - attributes - - provisioningConfig - properties: - type: - description: The 'type' property specifies the type of the Service Desk integration template. - type: string - example: Web Service SDIM - default: Web Service SDIM - attributes: - description: The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. - type: object - additionalProperties: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations using the template. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - /service-desk-integrations/status-check-configuration: - get: - tags: - - Service Desk Integration - summary: Get the time check configuration of queued SDIM tickets - description: Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: getStatusCheckDetails - responses: - '200': - description: QueuedCheckConfigDetails containing the configured values - content: - application/json: - schema: - description: Configuration of maximum number days and interval for checking Service Desk integration queue status - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks - type: string - example: 30 - provisioningMaxStatusCheckDays: - description: maximum number of days to check - type: string - example: 2 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:read' - - 'idn:service-desk-integration:read' - put: - tags: - - Service Desk Integration - summary: Update the time check configuration of queued SDIM tickets - description: Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - operationId: updateStatusCheckDetails - requestBody: - description: the modified time check configuration - content: - application/json: - schema: - description: Configuration of maximum number days and interval for checking Service Desk integration queue status - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks - type: string - example: 30 - provisioningMaxStatusCheckDays: - description: maximum number of days to check - type: string - example: 2 - required: true - responses: - '200': - description: QueuedCheckConfigDetails as updated - content: - application/json: - schema: - description: Configuration of maximum number days and interval for checking Service Desk integration queue status - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks - type: string - example: 30 - provisioningMaxStatusCheckDays: - description: maximum number of days to check - type: string - example: 2 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:service-desk-admin:write' - - 'idn:service-desk-integration:write' - /query-password-info: - post: - operationId: queryPasswordInfo - tags: - - Password Management - summary: Query Password Info - description: This API is used to query password related information. A token with API authority is required to call this API. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - userName: - type: string - description: The login name of the user - example: Abby.Smith - sourceName: - type: string - description: The display name of the source - example: My-AD - responses: - '200': - description: Reference to the password info. - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - description: Identity ID - example: 2c918085744fec4301746f9a5bce4605 - sourceId: - type: string - description: source ID - example: 2c918083746f642c01746f990884012a - publicKeyId: - type: string - description: public key ID - example: N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh - publicKey: - type: string - description: User's public key with Base64 encoding - example: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB - accounts: - type: array - description: Account info related to queried identity and source - items: - type: object - properties: - accountId: - type: string - description: 'Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350' - example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - accountName: - type: string - description: 'Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008' - example: Abby.Smith - policies: - type: array - description: Password constraints - items: - type: string - example: - - passwordRepeatedChar is 3 - - passwordMinAlpha is 1 - - passwordMinLength is 5 - - passwordMinNumeric is 1 - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /set-password: - post: - operationId: setPassword - tags: - - Password Management - summary: Set Identity's Password - description: This API is used to set a password for an identity. The password can only be set by the actual identity owner or by a trusted API client application. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - description: The identity ID that requested the password change - example: 8a807d4c73c545510173c545f0a002ff - encryptedPassword: - type: string - description: The RSA encrypted password - example: XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== - publicKeyId: - type: string - description: The encryption key ID - example: YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 - accountId: - type: string - description: 'Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350' - example: 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com' - sourceId: - type: string - description: The ID of the source for which identity is requesting the password change - example: 8a807d4c73c545510173c545d4b60246 - responses: - '202': - description: Reference to the password change. - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: true - description: The password change request ID - example: 089899f13a8f4da7824996191587bab9 - state: - type: string - enum: - - IN_PROGRESS - - FINISHED - - FAILED - description: Password change state - example: IN_PROGRESS - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/password-change-status/{id}': - get: - operationId: getPasswordChangeStatus - tags: - - Password Management - summary: Get Password Change Request Status - description: This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - example: 089899f13a8f4da7824996191587bab9 - description: Password change request ID - responses: - '200': - description: Status of the password change request - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: true - description: The password change request ID - example: 089899f13a8f4da7824996191587bab9 - state: - type: string - enum: - - IN_PROGRESS - - FINISHED - - FAILED - description: Password change state - example: IN_PROGRESS - errors: - type: array - items: - type: string - description: The errors during the password change request - example: - - The password change payload is invalid - sourceIds: - type: array - items: - type: string - description: List of source IDs in the password change request - example: - - 2c918083746f642c01746f990884012a - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /sources: - get: - operationId: listSources - tags: - - Sources - summary: Lists all sources in IdentityNow. - description: |- - This end-point lists all the sources in IdentityNow. - A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. - parameters: - - in: query - name: limit - description: |- - Note that for this API the maximum value for limit is 50. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 50 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 50 - default: 50 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - example: name eq "#Employees" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *co, eq, in, sw* - - **type**: *eq, in* - - **owner.id**: *eq, in* - - **features**: *ca, co* - - **created**: *eq* - - **modified**: *eq* - - **managementWorkgroup.id**: *eq* - - **description**: *eq* - - **authoritative**: *eq* - - **healthy**: *eq* - - **status**: *eq, in* - - **connectionType**: *eq* - - **connectorName**: *eq* - - in: query - name: sorters - schema: - type: string - format: comma-separated - example: name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status** - - in: query - name: for-subadmin - schema: - type: string - example: name - description: |- - Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. - Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - responses: - '200': - description: List of Source objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createSource - tags: - - Sources - summary: Creates a source in IdentityNow. - description: |- - This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - parameters: - - in: query - name: provisionAsCsv - description: Configures the source as a DelimitedFile type of source. - schema: - type: boolean - required: false - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - responses: - '201': - description: 'Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{id}': - get: - operationId: getSource - tags: - - Sources - summary: Get Source by ID - description: |- - This end-point gets a specific source in IdentityNow. - A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: A Source object - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: replaceSource - tags: - - Sources - summary: Update Source (Full) - description: | - This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source - configuration is completely replaced. - - Some fields are immutable and cannot be changed, such as: - - * id - * type - * authoritative - * connector - * connectorClass - * passwordPolicies - - Attempts to modify these fields will result in a 400 error. - - A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - responses: - '200': - description: 'Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: updateSource - tags: - - Sources - summary: Update Source (Partial) - description: | - This API partially updates a source in IdentityNow, using a list of patch operations according to the - [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - Some fields are immutable and cannot be changed, such as: - - * id - * type - * authoritative - * created - * modified - * connector - * connectorClass - * passwordPolicies - - Attempts to modify these fields will result in a 400 error. - - A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - description: 'A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in IdentityNow.' - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - examples: - Edit the source description: - description: This example shows how to edit a source description. - value: - - op: replace - path: /description - value: new description - Edit the source cluster: - description: This example shows how to edit a source cluster by id. - value: - - op: replace - path: /cluster/id - value: 2c918087813a902001813f3f85736b45 - Edit source features: - description: This example illustrates how you can update source supported features - value: - - op: replace - path: /features - value: - - PASSWORD - - PROVISIONING - - ENABLE - - AUTHENTICATE - Change a source description and cluster in One Call: - description: This example shows how multiple fields may be updated with a single patch call. - value: - - op: replace - path: /description - value: new description - - op: replace - path: /cluster/id - value: 2c918087813a902001813f3f85736b45 - Add a filter string to the connector: - description: 'This example shows how you can add a filter to incoming accounts during the account aggregation process. In the example below, any account that does not have an "m" or "d" in the id will be aggregated.' - value: - - op: add - path: /connectorAttributes/filterString - value: '!( id.contains( "m" ) ) || !( id.contains( "d" ) )' - Update connector attribute for specific operation type: - description: This example shows how you can update the 3rd object in the connection parameters operationType. This will change it from a standard group aggregation to a group aggregation on the "test" entitlement type - value: - - op: replace - path: /connectorAttributes/connectionParameters/2/operationType - value: Group Aggregation-test - responses: - '200': - description: 'Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.' - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteSource - tags: - - Sources - summary: Delete Source by ID - description: |- - This end-point deletes a specific source in IdentityNow. - A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - All of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}` - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - examples: - deleteSource: - summary: Response returned when deleting a source - value: - type: TASK_RESULT - id: 2c91808779ecf55b0179f720942f181a - name: null - links: - GetTaskStatusById: - operationId: getTaskStatus - parameters: - id: $response.body#/id - description: | - The `id` value returned in the response can be used as the `id` parameter in `GET /task-status/{id}`. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{sourceId}/provisioning-policies': - get: - operationId: listProvisioningPolicies - tags: - - Sources - summary: Lists ProvisioningPolicies - description: |- - This end-point lists all the ProvisioningPolicies in IdentityNow. - A token with API, or ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:provisioning-policy-list:read' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: List of ProvisioningPolicyDto objects - content: - application/json: - schema: - type: array - items: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createProvisioningPolicy - tags: - - Sources - summary: Create Provisioning Policy - description: |- - This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. - A token with ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:provisioning-policy:create' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - examples: - Create Account Provisioning Policy: - value: - name: Account - description: Account Provisioning Policy - usageType: CREATE - fields: - - name: displayName - transform: - type: identityAttribute - attributes: - name: displayName - attributes: {} - isRequired: false - type: string - isMultiValued: false - - name: distinguishedName - transform: - type: usernameGenerator - attributes: - sourceCheck: true - patterns: - - 'CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - - 'CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - - 'CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - - 'CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' - fn: - type: identityAttribute - attributes: - name: firstname - ln: - type: identityAttribute - attributes: - name: lastname - fi: - type: substring - attributes: - input: - type: identityAttribute - attributes: - name: firstname - begin: 0 - end: 1 - fti: - type: substring - attributes: - input: - type: identityAttribute - attributes: - name: firstname - begin: 0 - end: 2 - attributes: - cloudMaxUniqueChecks: '5' - cloudMaxSize: '100' - cloudRequired: 'true' - isRequired: false - type: '' - isMultiValued: false - - name: description - transform: - type: static - attributes: - value: '' - attributes: {} - isRequired: false - type: string - isMultiValued: false - responses: - '201': - description: Created ProvisioningPolicyDto object - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{sourceId}/provisioning-policies/{usageType}': - get: - operationId: getProvisioningPolicy - tags: - - Sources - summary: Get Provisioning Policy by UsageType - description: |- - This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:provisioning-policy:read' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - schema: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - description: The type of ProvisioningPolicy usage. - example: REGISTER - responses: - '200': - description: The requested ProvisioningPolicyDto was successfully retrieved. - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: replaceProvisioningPolicy - tags: - - Sources - summary: Update Provisioning Policy by UsageType - description: |- - This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. - A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:provisioning-policy:update' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - schema: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - description: The type of ProvisioningPolicy usage. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - responses: - '200': - description: The ProvisioningPolicyDto was successfully replaced. - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: updateProvisioningPolicy - tags: - - Sources - summary: Partial update of Provisioning Policy - description: |- - This API selectively updates an existing Provisioning Policy using a JSONPatch payload. - A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:provisioning-policy:update' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - schema: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - description: The type of ProvisioningPolicy usage. - requestBody: - required: true - description: The JSONPatch payload used to update the schema. - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - examples: - add-field: - summary: Add a field to the beginning of the list - value: - - op: add - path: /fields/0 - value: - name: email - transform: - type: identityAttribute - attributes: - name: email - attributes: {} - isRequired: false - type: string - isMultiValued: false - responses: - '200': - description: The ProvisioningPolicyDto was successfully updated. - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteProvisioningPolicy - tags: - - Sources - summary: Delete Provisioning Policy by UsageType - description: |- - Deletes the provisioning policy with the specified usage on an application. - A token with API, or ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:provisioning-policy:delete' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - schema: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - description: The type of ProvisioningPolicy usage. - responses: - '204': - description: The ProvisioningPolicyDto was successfully deleted. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{sourceId}/provisioning-policies/bulk-update': - post: - operationId: bulkUpdateProvisioningPolicies - tags: - - Sources - summary: Bulk Update Provisioning Policies - description: |- - This end-point updates a list of provisioning policies on the specified source in IdentityNow. - A token with API, or ORG_ADMIN authority is required to call this API. - security: - - oauth2: - - 'idn:provisioning-policy-bulk:update' - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - responses: - '200': - description: A list of the ProvisioningPolicyDto was successfully replaced. - content: - application/json: - schema: - type: array - items: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{sourceId}/schemas': - get: - operationId: listSchemas - tags: - - Sources - summary: List Schemas on a Source - description: | - Lists the Schemas that exist on the specified Source in IdentityNow. - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: query - name: include-types - required: false - schema: - type: string - description: 'If set to ''group'', then the account schema is filtered and only group schemas are returned. Only a value of ''group'' is recognized.' - example: group - responses: - '200': - description: The Schemas were successfully retrieved. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: createSchema - tags: - - Sources - summary: Create Schema on a Source - description: | - Creates a new Schema on the specified Source in IdentityNow. - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - responses: - '201': - description: The Schema was successfully created on the specified Source. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{sourceId}/schemas/{schemaId}': - get: - operationId: getSchema - tags: - - Sources - summary: Get Source Schema by ID - description: | - Get the Source Schema by ID in IdentityNow. - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: The requested Schema was successfully retrieved. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - put: - operationId: replaceSchema - tags: - - Sources - summary: Update Source Schema (Full) - description: | - This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. - - * id - * name - * created - * modified - - Any attempt to modify these fields will result in an error response with a status code of 400. - - > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - responses: - '200': - description: The Schema was successfully replaced. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - patch: - operationId: updateSchema - tags: - - Sources - summary: Update Source Schema (Partial) - description: |- - This API can be used to selectively update an existing Schema using a JSONPatch payload. Some fields of the Schema cannot be updated. These fields are listed below. - * id - * name - * created - * modified - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - description: The JSONPatch payload used to update the schema. - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: 'A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)' - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: 'The value to be used for the operation, required for "add" and "replace" operations' - example: New description - examples: - add-attribute: - summary: Add an attribute to the end of the list - value: - - op: add - path: /attributes/- - value: - name: location - type: STRING - schema: null - description: Employee location - isMulti: false - isEntitlement: false - isGroup: false - responses: - '200': - description: The Schema was successfully updated. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - delete: - operationId: deleteSchema - tags: - - Sources - summary: Delete Source Schema by ID - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '204': - description: The Schema was successfully deleted. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{sourceId}/source-health': - get: - operationId: getSourceHealth - tags: - - Sources - summary: This API fetches source health by source's id - description: This endpoint fetches source health by source's id - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: Fetched source health successfully - content: - application/json: - schema: - type: object - description: Dto for source health data - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - name: - type: string - description: the name of the source - example: Source1234 - org: - type: string - description: source's org - example: denali-cjh - isAuthoritative: - type: boolean - isCluster: - type: boolean - hostname: - type: string - example: megapod-useast1-secret-hostname.sailpoint.com - pod: - type: string - description: source's pod - example: megapod-useast1 - iqServiceVersion: - type: string - example: iqVersion123 - status: - type: string - enum: - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - description: connection test result - example: SOURCE_STATE_UNCHECKED_SOURCE - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/sources/{id}/schemas/accounts': - get: - tags: - - Sources - summary: Downloads source accounts schema template - description: |- - This API downloads the CSV schema that defines the account attributes on a source. - >**NOTE: This API is designated only for Delimited File sources.** - operationId: downloadSourceAccountsSchema - parameters: - - in: path - name: id - required: true - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - responses: - '200': - description: Successfully downloaded the file - content: - text/csv: - example: 'id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:source-schema:read' - post: - tags: - - Sources - summary: Uploads source accounts schema template - description: |- - This API uploads a source schema template file to configure a source's account attributes. - - To retrieve the file to modify and upload, log into Identity Now. - - Click **Admin** -> **Connections** -> **Sources** -> **``** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: uploadSourceAccountsSchema - parameters: - - in: path - name: id - required: true - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Successfully uploaded the file - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:source-schema:update' - '/sources/{id}/schemas/entitlements': - get: - tags: - - Sources - summary: Downloads source entitlements schema template - description: |- - This API downloads the CSV schema that defines the entitlement attributes on a source. - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: downloadSourceEntitlementsSchema - parameters: - - in: path - name: id - required: true - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: schemaName - schema: - type: string - description: Name of entitlement schema - example: '?schemaName=group' - responses: - '200': - description: Successfully downloaded the file - content: - text/csv: - example: 'id,name,displayName,created,description,modified,entitlements,groups,permissions' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:source-schema:read' - post: - tags: - - Sources - summary: Uploads source entitlements schema template - description: |- - This API uploads a source schema template file to configure a source's entitlement attributes. - - To retrieve the file to modify and upload, log into Identity Now. - - Click **Admin** -> **Connections** -> **Sources** -> **``** -> **Import Data** -> **Import Entitlements** -> **Download** - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: uploadSourceEntitlementsSchema - parameters: - - in: path - name: id - required: true - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: schemaName - schema: - type: string - description: Name of entitlement schema - example: '?schemaName=group' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Successfully uploaded the file - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - type: array - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - description: The features that the schema supports. - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - description: The type of the attribute. - example: string - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - schema: - description: A reference to the schema on the source to which the values of the attribute map. - example: - type: CONNECTOR_SCHEMA - id: 2c9180866166b5b0016167c32ef31a66 - name: group - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: - type: string - description: A human-readable description of the attribute. - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - isGroup: - type: boolean - description: Flag indicating whether or not the attribute represents a group. - example: false - readOnly: true - example: - - name: sAMAccountName - type: string - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: string - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:source-schema:update' - '/sources/{sourceId}/upload-connector-file': - post: - operationId: uploadConnectorFile - tags: - - Sources - summary: Upload connector file to source - parameters: - - in: path - name: sourceId - required: true - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - description: |- - This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. - A token with ORG_ADMIN authority is required to call this API. - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Uploaded the file successfully and sent all post-upload events - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /transforms: - get: - tags: - - Transforms - summary: List transforms - description: |- - Gets a list of all saved transform objects. - A token with transforms-list read authority is required to call this API. - operationId: getTransformsList - parameters: - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - name: name - in: query - description: Name of the transform to retrieve from the list. - required: false - style: form - schema: - type: string - example: ExampleTransformName123 - - name: filters - in: query - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - Filtering is supported for the following fields and operators: - **internal**: *eq* - **name**: *eq*, *sw* - required: false - style: form - explode: true - example: name eq "Uppercase" - schema: - type: string - responses: - '200': - description: A list of transforms matching the given criteria. - content: - application/json: - schema: - type: array - items: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - example: - - id: 2cd78adghjkja34jh2b1hkjhasuecd - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' - outputFormat: yyyy/dd/MM - internal: false - - id: 2lkas8dhj4bkuakja77giih7l4ashh - name: PrefixSubstring - type: substring - attributes: - begin: 0 - end: 3 - internal: true - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:transforms-list:read' - post: - tags: - - Transforms - summary: Create transform - description: 'Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API.' - operationId: createTransform - requestBody: - required: true - description: The transform to be created. - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - example: - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: 'MMM dd yyyy, HH:mm:ss.SSS' - outputFormat: yyyy/dd/MM - responses: - '201': - description: Indicates the transform was successfully created and returns its representation. - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:transforms:write' - '/transforms/{id}': - get: - tags: - - Transforms - summary: Transform by ID - description: |- - This API returns the transform specified by the given ID. - A token with transform read authority is required to call this API. - operationId: getTransform - parameters: - - name: id - in: path - description: ID of the transform to retrieve - required: true - style: simple - explode: false - example: 2cd78adghjkja34jh2b1hkjhasuecd - schema: - type: string - responses: - '200': - description: Transform with the given ID - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:transforms:read' - put: - tags: - - Transforms - summary: Update a transform - description: |- - Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. - A token with transform write authority is required to call this API. - operationId: updateTransform - parameters: - - name: id - in: path - description: ID of the transform to update - required: true - style: simple - explode: false - schema: - type: string - requestBody: - description: 'The updated transform object (must include "name", "type", and "attributes" fields).' - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - example: - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' - outputFormat: yyyy/dd/MM - responses: - '200': - description: Indicates the transform was successfully updated and returns its new representation. - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - example: - id: 2cd78adghjkja34jh2b1hkjhasuecd - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: 'MMM-dd-yyyy, HH:mm:ss.SSS' - outputFormat: yyyy/dd/MM - internal: false - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:transforms:write' - delete: - tags: - - Transforms - summary: Delete a transform - description: |- - Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - A token with transform delete authority is required to call this API. - operationId: deleteTransform - parameters: - - name: id - in: path - description: ID of the transform to delete - required: true - style: simple - explode: false - schema: - type: string - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - oauth2: - - 'idn:transforms:delete' - /work-items: - get: - operationId: listWorkItems - tags: - - Work Items - summary: List Work Items - description: 'This gets a collection of work items belonging to either the specified user(admin required), or the current user.' - parameters: - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - responses: - '200': - description: List of work items - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /work-items/completed: - get: - operationId: completedWorkItems - tags: - - Work Items - summary: Completed Work Items - description: 'This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.' - parameters: - - in: query - name: ownerId - schema: - type: string - description: 'The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.' - required: false - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - responses: - '200': - description: List of completed work items. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /work-items/count: - get: - operationId: countWorkItems - tags: - - Work Items - summary: Count Work Items - description: 'This gets a count of work items belonging to either the specified user(admin required), or the current user.' - parameters: - - in: query - name: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - responses: - '200': - description: List of work items - content: - application/json: - schema: - type: object - properties: - count: - type: integer - description: The count of work items - example: 29 - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /work-items/completed/count: - get: - operationId: countCompletedWorkItems - tags: - - Work Items - summary: Count Completed Work Items - description: 'This gets a count of completed work items belonging to either the specified user(admin required), or the current user.' - parameters: - - in: query - name: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - responses: - '200': - description: List of work items - content: - application/json: - schema: - type: object - properties: - count: - type: integer - description: The count of work items - example: 29 - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - /work-items/summary: - get: - operationId: summaryWorkItems - tags: - - Work Items - summary: Work Items Summary - description: 'This gets a summary of work items belonging to either the specified user(admin required), or the current user.' - parameters: - - in: query - name: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - responses: - '200': - description: List of work items - content: - application/json: - schema: - type: object - properties: - open: - type: integer - description: The count of open work items - example: 29 - completed: - type: integer - description: The count of completed work items - example: 1 - total: - type: integer - description: The count of total work items - example: 30 - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/work-items/{id}': - get: - operationId: getWorkItems - tags: - - Work Items - summary: Get a Work Item - description: 'This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: ID of the work item. - responses: - '200': - description: The work item with the given ID. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - post: - operationId: completeWorkItem - tags: - - Work Items - summary: Complete a Work Item - description: 'This API completes a work item. Either an admin, or the owning/current user must make this request.' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: A WorkItems object - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/work-items/{id}/approve/{approvalItemId}': - post: - operationId: approveApprovalItem - tags: - - Work Items - summary: Approve an Approval Item - description: 'This API approves an Approval Item. Either an admin, or the owning/current user must make this request.' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: approvalItemId - schema: - type: string - required: true - description: The ID of the approval item. - example: 1211bcaa32112bcef6122adb21cef1ac - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/work-items/{id}/reject/{approvalItemId}': - post: - operationId: rejectApprovalItem - tags: - - Work Items - summary: Reject an Approval Item - description: 'This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: approvalItemId - schema: - type: string - required: true - description: The ID of the approval item. - example: 1211bcaa32112bcef6122adb21cef1ac - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/work-items/bulk-approve/{id}': - post: - operationId: bulkApproveApprovalItem - tags: - - Work Items - summary: Bulk approve Approval Items - description: 'This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/work-items/bulk-reject/{id}': - post: - operationId: bulkRejectApprovalItem - tags: - - Work Items - summary: Bulk reject Approval Items - description: 'This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - '/work-items/{id}/submit-account-selection': - post: - operationId: submitAccountSelection - tags: - - Work Items - summary: Submit Account Selections - description: 'This API submits account selections. Either an admin, or the owning/current user must make this request.' - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: true - example: - fieldName: fieldValue - description: 'Account Selection Data map, keyed on fieldName' - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - '401': - description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.' - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.' - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - type: object - properties: - locale: - type: string - description: 'The locale for the message text, a BCP 47 language tag.' - example: en-US - localeOrigin: - type: string - enum: - - DEFAULT - - REQUEST - description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.' - example: DEFAULT - text: - type: string - description: Actual text of the error message in the indicated locale. - example: The request was syntactically correct but its content is semantically invalid. - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. -security: - - oauth2: [] -components: - securitySchemes: - oauth2: - type: oauth2 - description: | - OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information. - - Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) - - Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) - - Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) - - Which authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use) - - Learn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details) - flows: - clientCredentials: - tokenUrl: 'https://tenant.api.identitynow.com/oauth/token' - scopes: - 'sp:scopes:default': default scope - 'sp:scopes:all': access to all scopes - authorizationCode: - authorizationUrl: 'https://tenant.identitynow.com/oauth/authorize' - tokenUrl: 'https://tenant.api.identitynow.com/oauth/token' - scopes: - 'sp:scopes:default': default scope - 'sp:scopes:all': access to all scopes - schemas: - AccessRequest: - type: object - properties: - requestedFor: - description: 'A list of Identity IDs for whom the Access is requested. If it''s a Revoke request, there can only be one Identity ID.' - type: array - items: - type: string - example: 2c918084660f45d6016617daa9210584 - requestType: - type: string - enum: - - GRANT_ACCESS - - REVOKE_ACCESS - description: Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. Currently REVOKE_ACCESS is not supported for entitlements. - example: GRANT_ACCESS - requestedItems: - type: array - items: - type: object - properties: - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of the item being requested. - example: ACCESS_PROFILE - id: - type: string - description: 'ID of Role, Access Profile or Entitlement being requested.' - example: 2c9180835d2e5168015d32f890ca1581 - comment: - type: string - description: | - Comment provided by requester. - * Comment is required when the request is of type Revoke Access. - example: Requesting access profile for John Doe - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - removeDate: - type: string - description: | - The date the role or access profile is no longer assigned to the specified identity. - * Specify a date in the future. - * The current SLA for the deprovisioning is 24 hours. - * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. - * Currently it is not supported for entitlements. - format: date-time - example: '2020-07-11T21:23:15.000Z' - required: - - id - - type - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - required: - - requestedFor - - requestedItems - AccessRequestItem: - type: object - properties: - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of the item being requested. - example: ACCESS_PROFILE - id: - type: string - description: 'ID of Role, Access Profile or Entitlement being requested.' - example: 2c9180835d2e5168015d32f890ca1581 - comment: - type: string - description: | - Comment provided by requester. - * Comment is required when the request is of type Revoke Access. - example: Requesting access profile for John Doe - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - removeDate: - type: string - description: | - The date the role or access profile is no longer assigned to the specified identity. - * Specify a date in the future. - * The current SLA for the deprovisioning is 24 hours. - * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. - * Currently it is not supported for entitlements. - format: date-time - example: '2020-07-11T21:23:15.000Z' - required: - - id - - type - AccessProfileDocument: - description: 'This is more of a complete representation of an access profile. ' - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - entitlementCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - AccessProfileSummary: - description: 'This is a summary representation of an access profile. ' - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - AccessReviewReassignment: - type: object - properties: - reassign: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of item or identity being reassigned. - example: ef38f94347e94562b5bb8424a56397d8 - type: - type: string - enum: - - TARGET_SUMMARY - - ITEM - - IDENTITY_SUMMARY - required: - - id - - type - reassignTo: - type: string - description: The ID of the identity to which the certification is reassigned - example: ef38f94347e94562b5bb8424a56397d8 - reason: - type: string - description: The reason comment for why the reassign was made - example: reassigned for some reason - required: - - reassign - - reassignTo - - reason - Account: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - properties: - sourceId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - identityId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - attributes: - type: object - authoritative: - type: boolean - description: - type: string - disabled: - type: boolean - locked: - type: boolean - nativeIdentity: - type: string - systemAccount: - type: boolean - uncorrelated: - type: boolean - uuid: - type: string - manuallyCorrelated: - type: boolean - hasEntitlements: - type: boolean - AccountActivity: - type: object - properties: - id: - type: string - description: Id of the account activity itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - completed: - type: string - format: date-time - nullable: true - example: '2018-10-19T13:49:37.385Z' - completionStatus: - nullable: true - type: string - enum: - - SUCCESS - - FAILURE - - INCOMPLETE - - PENDING - type: - type: string - example: appRequest - requesterIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - targetIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - errors: - nullable: true - type: array - items: - type: string - example: - - 'sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.' - warnings: - nullable: true - type: array - items: - type: string - example: - - 'Some warning, another warning' - items: - type: array - items: - type: object - properties: - id: - type: string - description: Item id - example: 2725138ee34949beb0d6cc982d2d4625 - name: - type: string - description: Human-readable display name of item - requested: - type: string - format: date-time - description: Date and time item was requested - example: '2017-07-11T18:45:37.098Z' - approvalStatus: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - provisioningStatus: - type: string - enum: - - PENDING - - FINISHED - - UNVERIFIABLE - - COMMITED - - FAILED - - RETRY - description: Provisioning state of an account activity item - requesterComment: - type: object - nullable: true - properties: - commenterId: - type: string - description: Id of the identity making the comment - example: 2c918084660f45d6016617daa9210584 - commenterName: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - body: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. - date: - type: string - format: date-time - description: Date and time comment was made - example: '2017-07-11T18:45:37.098Z' - reviewerIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - reviewerComment: - type: object - nullable: true - properties: - commenterId: - type: string - description: Id of the identity making the comment - example: 2c918084660f45d6016617daa9210584 - commenterName: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - body: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. - date: - type: string - format: date-time - description: Date and time comment was made - example: '2017-07-11T18:45:37.098Z' - operation: - type: string - enum: - - ADD - - CREATE - - MODIFY - - DELETE - - DISABLE - - ENABLE - - UNLOCK - - LOCK - - REMOVE - description: Represents an operation in an account activity item - attribute: - type: string - description: Attribute to which account activity applies - nullable: true - example: detectedRoles - value: - type: string - description: Value of attribute - nullable: true - example: 'Treasury Analyst [AccessProfile-1529010191212]' - nativeIdentity: - nullable: true - type: string - description: Native identity in the target system to which the account activity applies - example: Sandie.Camero - sourceId: - type: string - description: Id of Source to which account activity applies - example: 2c91808363ef85290164000587130c0c - accountRequestInfo: - type: object - nullable: true - properties: - requestedObjectId: - type: string - description: Id of requested object - example: 2c91808563ef85690164001c31140c0c - requestedObjectName: - type: string - description: Human-readable name of requested object - example: Treasury Analyst - requestedObjectType: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice. - example: ACCESS_PROFILE - description: 'If an account activity item is associated with an access request, captures details of that request.' - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: 'Arbitrary key-value pairs, if any were included in the corresponding access request item' - removeDate: - nullable: true - type: string - description: The date the role or access profile is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - executionStatus: - type: string - enum: - - EXECUTING - - VERIFYING - - TERMINATED - - COMPLETED - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: 'Arbitrary key-value pairs, if any were included in the corresponding access request' - AccountActivitySearchedItem: - description: AccountActivity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - action: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - origin: - type: string - status: - type: string - requester: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - recipient: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - trackingNumber: - type: string - errors: - type: array - items: - type: string - warnings: - type: array - items: - type: string - approvals: - type: array - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - commenter: - type: string - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: string - type: - type: string - originalRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - expansionItems: - type: array - items: - type: object - properties: - accountId: - type: string - cause: - type: string - name: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - accountRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - provisioningTarget: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: object - properties: - errors: - type: array - items: - type: string - status: - type: string - ticketId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - sources: - type: array - items: - type: string - AccountAttributes: - type: object - required: - - attributes - properties: - attributes: - description: The schema attribute values for the account - type: object - example: - city: Austin - displayName: John Doe - userName: jdoe - sAMAccountName: jDoe - mail: john.doe@sailpoint.com - AccountDocument: - description: Account - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - attributes: - type: object - description: a map or dictionary of key/value pairs - identity: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - access: - type: array - items: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - entitlementCount: - type: integer - uncorrelated: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - AccountsAsyncResult: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - AccountToggleRequest: - description: Request used for account enable/disable - type: object - properties: - externalVerificationId: - description: 'If set, an external process validates that the user wants to proceed with this request.' - type: string - example: 3f9180835d2e5168015d32f890ca1581 - forceProvisioning: - description: 'If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing ''true'' for an unlocked account will add and process ''Unlock'' operation by the workflow.' - type: boolean - example: false - AccountUnlockRequest: - description: Request used for account unlock - type: object - properties: - externalVerificationId: - description: 'If set, an external process validates that the user wants to proceed with this request.' - type: string - example: 3f9180835d2e5168015d32f890ca1581 - unlockIDNAccount: - description: 'If set, the IDN account is unlocked after the workflow completes.' - type: boolean - example: false - forceProvisioning: - description: 'If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.' - type: boolean - example: false - Aggregation: - description: Aggregation - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - status: - type: string - duration: - type: integer - avgDuration: - type: integer - changedAccounts: - type: integer - nextScheduled: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - startTime: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - sourceOwner: - type: string - ApprovalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - Campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - Certification: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - name: - example: 'Source Owner Access Review for Employees [source]' - type: string - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - identitiesTotal: - type: integer - description: 'The total number of identities in the Certification, both complete and incomplete.' - example: 10 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - type: boolean - example: false - errorMessage: - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - CertificationReference: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - EntitlementDocument: - description: Entitlement - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - displayName: - type: string - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - identityCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - EntitlementSummary: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - Event: - description: Event - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - action: - type: string - type: - type: string - actor: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - target: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - stack: - type: string - trackingNumber: - type: string - ipAddress: - type: string - details: - type: string - attributes: - type: object - objects: - type: array - items: - type: string - operation: - type: string - status: - type: string - technicalName: - type: string - IdentityDocument: - description: Identity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - firstName: - type: string - lastName: - type: string - displayName: - type: string - email: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - phone: - type: string - inactive: - type: boolean - protected: - type: boolean - status: - type: string - employeeNumber: - type: string - manager: - nullable: true - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - isManager: - type: boolean - identityProfile: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - attributes: - type: object - description: a map or dictionary of key/value pairs - processingState: - type: string - nullable: true - processingDetails: - nullable: true - type: object - properties: - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - retryCount: - type: integer - stackTrace: - type: string - message: - type: string - accounts: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - accountCount: - type: integer - apps: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - account: - type: object - properties: - id: - type: string - accountId: - type: string - appCount: - type: integer - access: - type: array - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfile.yaml - ENTITLEMENT: ../access/Entitlement.yaml - ROLE: ../access/Role.yaml - oneOf: - - description: 'This is a summary representation of an access profile. ' - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - accessProfileCount: - type: integer - entitlementCount: - type: integer - roleCount: - type: integer - owns: - type: object - properties: - sources: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - roles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - apps: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - governanceGroups: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - fallbackApprover: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - IdentityProfile: - allOf: - - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - - type: object - properties: - description: - type: string - description: The description of the Identity Profile. - example: My custom flat file profile - owner: - description: The owner of the Identity Profile. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - priority: - type: integer - format: int64 - description: The priority for an Identity Profile. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Type of the object to which this reference applies - example: SOURCE - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: HR Active Directory - identityRefreshRequired: - type: boolean - description: True if a identity refresh is needed. Typically triggered when a change on the source has been made. - example: true - identityCount: - type: integer - description: The number of identities that belong to the Identity Profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: The backend will only promote values if the profile/mapping is enabled. - type: boolean - example: true - attributeTransforms: - type: array - items: - type: object - description: Defines a transformation definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Name of the identity attribute. - example: email - transformDefinition: - description: The seaspray transformation definition. - type: object - properties: - type: - type: string - description: The type of the transform definition. - example: accountAttribute - attributes: - type: object - additionalProperties: - type: object - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - properties: - taskResultId: - type: string - format: uuid - description: The id of the task result. - example: 2c918086795cd09201795d5f7d7533df - reportName: - type: string - example: My annual report - description: The name of the report. - hasTimeBasedAttr: - description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. - type: boolean - example: true - IdentityReferenceWithNameAndEmail: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - ProvisioningConfig: - type: object - description: Specification of a Service Desk integration provisioning configuration. - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - ProvisioningPolicy: - type: object - required: - - name - properties: - name: - type: string - description: - type: string - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - ENABLE - - DISABLE - - UNLOCK - - CHANGE_PASSWORD - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: '${firstname}.${lastname}${uniqueCounter}' - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - QueuedCheckConfigDetails: - description: Configuration of maximum number days and interval for checking Service Desk integration queue status - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks - type: string - example: 30 - provisioningMaxStatusCheckDays: - description: maximum number of days to check - type: string - example: 2 - Reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - ReassignmentReference: - type: object - properties: - id: - type: string - description: The ID of item or identity being reassigned. - example: ef38f94347e94562b5bb8424a56397d8 - type: - type: string - enum: - - TARGET_SUMMARY - - ITEM - - IDENTITY_SUMMARY - required: - - id - - type - RemediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - RequestableObject: - type: object - properties: - id: - type: string - description: Id of the requestable object itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Human-readable display name of the requestable object - example: Applied Research Access - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - nullable: true - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: Description of the requestable object. - example: 'Access to research information, lab results, and schematics.' - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice. - example: ACCESS_PROFILE - requestStatus: - type: string - enum: - - AVAILABLE - - PENDING - - ASSIGNED - description: 'Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.' - identityRequestId: - type: string - description: 'If *requestStatus* is *PENDING*, indicates the id of the associated account activity.' - nullable: true - example: null - ownerRef: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only - example: IDENTITY - id: - type: string - description: Identity id. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Human-readable display name of identity. This is read-only - example: Alison Ferguso - email: - type: string - description: Email address of identity. This is read-only - example: alison.ferguso@identitysoon.com - requestCommentsRequired: - type: boolean - description: Whether the requester must provide comments when requesting the object. - RequestableObjectType: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice. - example: ACCESS_PROFILE - RequestableObjectRequestStatus: - type: string - enum: - - AVAILABLE - - PENDING - - ASSIGNED - description: 'Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.' - Reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - RoleDocument: - description: Role - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfileCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - RoleSummary: - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - SearchDocument: - discriminator: - propertyName: _type - mapping: - accessprofile: ../model/access/profile/AccessProfile.yaml - accountactivity: ../model/account/activity/AccountActivity.yaml - account: ../model/account/Account.yaml - aggregation: ../model/aggregation/Aggregation.yaml - entitlement: ../model/entitlement/Entitlement.yaml - event: ../model/event/Event.yaml - identity: ../model/identity/Identity.yaml - role: ../model/role/Role.yaml - oneOf: - - description: 'This is more of a complete representation of an access profile. ' - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - entitlementCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: AccountActivity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - action: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - origin: - type: string - status: - type: string - requester: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - recipient: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - trackingNumber: - type: string - errors: - type: array - items: - type: string - warnings: - type: array - items: - type: string - approvals: - type: array - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - commenter: - type: string - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: string - type: - type: string - originalRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - expansionItems: - type: array - items: - type: object - properties: - accountId: - type: string - cause: - type: string - name: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - accountRequests: - type: array - items: - type: object - properties: - accountId: - type: string - attributeRequests: - type: array - items: - type: object - properties: - name: - type: string - op: - type: string - value: - type: string - op: - type: string - provisioningTarget: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - result: - type: object - properties: - errors: - type: array - items: - type: string - status: - type: string - ticketId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - sources: - type: array - items: - type: string - - description: Account - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - attributes: - type: object - description: a map or dictionary of key/value pairs - identity: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - access: - type: array - items: - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - entitlementCount: - type: integer - uncorrelated: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Aggregation - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - status: - type: string - duration: - type: integer - avgDuration: - type: integer - changedAccounts: - type: integer - nextScheduled: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - startTime: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - sourceOwner: - type: string - - description: Entitlement - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - attribute: - type: string - value: - type: string - - type: object - properties: - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - displayName: - type: string - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - identityCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Event - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - type: object - properties: - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - action: - type: string - type: - type: string - actor: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - target: - type: object - properties: - name: - type: string - example: John Doe - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - stack: - type: string - trackingNumber: - type: string - ipAddress: - type: string - details: - type: string - attributes: - type: object - objects: - type: array - items: - type: string - operation: - type: string - status: - type: string - technicalName: - type: string - - description: Identity - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - firstName: - type: string - lastName: - type: string - displayName: - type: string - email: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - phone: - type: string - inactive: - type: boolean - protected: - type: boolean - status: - type: string - employeeNumber: - type: string - manager: - nullable: true - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - isManager: - type: boolean - identityProfile: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - attributes: - type: object - description: a map or dictionary of key/value pairs - processingState: - type: string - nullable: true - processingDetails: - nullable: true - type: object - properties: - date: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - stage: - type: string - retryCount: - type: integer - stackTrace: - type: string - message: - type: string - accounts: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - accountId: - type: string - source: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - disabled: - type: boolean - locked: - type: boolean - privileged: - type: boolean - manuallyCorrelated: - type: boolean - passwordLastSet: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - entitlementAttributes: - type: object - nullable: true - description: a map or dictionary of key/value pairs - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - accountCount: - type: integer - apps: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - account: - type: object - properties: - id: - type: string - accountId: - type: string - appCount: - type: integer - access: - type: array - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfile.yaml - ENTITLEMENT: ../access/Entitlement.yaml - ROLE: ../access/Role.yaml - oneOf: - - description: 'This is a summary representation of an access profile. ' - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - - description: EntitlementReference - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - privileged: - type: boolean - attribute: - type: string - value: - type: string - standalone: - type: boolean - - description: Role - allOf: - - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - description: - type: string - nullable: true - - type: object - properties: - owner: - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - displayName: - type: string - example: John Q. Doe - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - accessProfileCount: - type: integer - entitlementCount: - type: integer - roleCount: - type: integer - owns: - type: object - properties: - sources: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - entitlements: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - roles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - apps: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - governanceGroups: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - fallbackApprover: - type: boolean - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - - description: Role - allOf: - - type: object - required: - - id - - name - - _type - properties: - id: - type: string - name: - type: string - _type: - description: |- - Enum representing 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 - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - description: - type: string - created: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - modified: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - synced: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - enabled: - type: boolean - requestable: - type: boolean - requestCommentsRequired: - type: boolean - owner: - allOf: - - allOf: - - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - - type: object - properties: - email: - type: string - - type: object - properties: - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - example: John Doe - accessProfileCount: - type: integer - tags: - type: array - items: - type: string - example: - - TAG_1 - - TAG_2 - SavedSearch: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - example: Disabled accounts - - type: object - properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - created: - description: | - The date the saved search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the saved search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - header: - description: | - The value of the header. - type: string - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: email - header: Work Email - - field: attributes.cloudLifecycleState - header: Lifecycle State - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - items: - type: string - example: - - disabled - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - description: The lower bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - upper: - description: The upper bound of the range. - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - terms: - description: The terms to be filtered. - type: array - items: - type: string - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - required: - - indices - - query - Schedule: - type: object - description: | - The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - months: - description: The months selected. - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - days: - description: | - The days selected. - example: - type: LIST - values: - - MON - - WED - - FRI - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - hours: - description: | - The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - expiration: - description: | - The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: | - The ID of the time zone for the schedule. - type: string - example: 'GMT-06:00' - required: - - type - - hours - ScheduledSearch: - type: object - allOf: - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - description: - description: | - The description of the scheduled search. - type: string - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: | - The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - description: | - The date the scheduled search was initially created. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - description: | - The last date the scheduled search was modified. - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - schedule: - type: object - description: | - The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - example: WEEKLY - months: - description: The months selected. - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - days: - description: | - The days selected. - example: - type: LIST - values: - - MON - - WED - - FRI - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - hours: - description: | - The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - type: object - nullable: true - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - expiration: - description: | - The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - timeZoneId: - description: | - The ID of the time zone for the schedule. - type: string - example: 'GMT-06:00' - required: - - type - - hours - recipients: - description: | - The email recipients. - type: array - items: - type: object - description: | - A typed reference to the object. - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - emailEmptyResults: - description: | - Indicates if email generation should not be suppressed if search returns no results. - type: boolean - default: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - required: - - savedSearchId - - schedule - - recipients - - type: object - properties: - id: - description: | - The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the scheduled search. - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - ownerId: - description: The ID of the scheduled search owner - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - ServiceDeskIntegrationDto: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: Specification of a Service Desk integration - required: - - description - - type - - attributes - properties: - description: - description: Description of the Service Desk integration - type: string - example: A very nice Service Desk integration - type: - description: Type of the Service Desk integration - type: string - default: ServiceNowSDIM - ownerRef: - description: Reference to the identity that is the owner of this Service Desk integration - default: - type: IDENTITY - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - clusterRef: - description: Reference to the source cluster for this Service Desk integration - default: - type: CLUSTER - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: 'ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)' - type: string - example: xyzzy999 - deprecated: true - managedSources: - description: 'Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)' - type: array - items: - type: string - deprecated: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - beforeProvisioningRule: - description: Reference to beforeProvisioningRule for this Service Desk integration - default: - type: RULE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - ServiceDeskIntegrationTemplateDto: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - created: - description: Creation date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: 2015-05-28T14:07:17.000Z - format: date-time - readOnly: true - - type: object - description: 'This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations.' - required: - - type - - attributes - - provisioningConfig - properties: - type: - description: The 'type' property specifies the type of the Service Desk integration template. - type: string - example: Web Service SDIM - default: Web Service SDIM - attributes: - description: The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. - type: object - additionalProperties: true - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations using the template. - type: object - properties: - universalManager: - description: 'Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.' - type: boolean - readOnly: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - default: - type: SOURCE - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - ServiceDeskIntegrationTemplateType: - description: This represents a Service Desk Integration template type. - required: - - type - - scriptName - type: object - properties: - name: - description: This is the name of the type. - example: aName - type: string - type: - description: This is the type value for the type. - example: aType - type: string - scriptName: - description: This is the scriptName attribute value for the type. - example: aScriptName - type: string - Source: - type: object - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - description: - type: string - description: Human-readable description of the source - example: This is the corporate directory. - owner: - description: Reference to an owning Identity Object - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - cluster: - description: Reference to the associated Cluster - example: - type: CLUSTER - id: 2c9180866166b5b0016167c32ef31a66 - name: Corporate Cluster - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationConfig: - description: Reference to a Correlation Config object - example: - type: ACCOUNT_CORRELATION_CONFIG - id: 2c9180855d191c59015d28583727245a - name: 'Directory [source-62867] Account Correlation' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - accountCorrelationRule: - description: 'Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can''t be used.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - managerCorrelationMapping: - description: Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity - type: object - properties: - accountAttribute: - type: string - description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. - example: manager - identityAttribute: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - managerCorrelationRule: - description: 'Reference to the ManagerCorrelationRule, only used when a simple filter isn''t sufficient.' - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - schemas: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to Schema objects - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - items: - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - features: - type: array - description: Optional features that can be supported by a source. - items: - type: string - enum: - - AUTHENTICATE - - COMPOSITE - - DIRECT_PERMISSIONS - - DISCOVER_SCHEMA - - ENABLE - - MANAGER_LOOKUP - - NO_RANDOM_ACCESS - - PROXY - - SEARCH - - TEMPLATE - - UNLOCK - - UNSTRUCTURED_TARGETS - - SHAREPOINT_TARGET - - PROVISIONING - - GROUP_PROVISIONING - - SYNC_PROVISIONING - - PASSWORD - - CURRENT_PASSWORD - - ACCOUNT_ONLY_REQUEST - - ADDITIONAL_ACCOUNT_REQUEST - - NO_AGGREGATION - - GROUPS_HAVE_MEMBERS - - NO_PERMISSIONS_PROVISIONING - - NO_GROUP_PERMISSIONS_PROVISIONING - - NO_UNSTRUCTURED_TARGETS_PROVISIONING - - NO_DIRECT_PERMISSIONS_PROVISIONING - description: |- - Optional features that can be supported by an source. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. - * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. - * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - example: - - SYNC_PROVISIONING - - MANAGER_LOOKUP - - SEARCH - - PROVISIONING - - AUTHENTICATE - - GROUP_PROVISIONING - - PASSWORD - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: The fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration; will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When true indicates the source is referenced by an IdentityProfile. - example: false - managementWorkgroup: - description: Reference to Management Workgroup for this Source - type: object - properties: - type: - description: DTO type - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - healthy: - type: boolean - description: When true indicates a healthy source - example: true - status: - type: string - description: 'A status identifier, giving specific information on why a source is healthy or not' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp showing when a source health check was last performed - example: '2021-09-28T15:48:29.3801666300Z' - connectorId: - type: string - description: The id of connector - example: active-directory - connectorName: - type: string - description: The name of the connector that was chosen on source creation - example: Active Directory - connectionType: - type: string - description: The type of connection (direct or file) - example: file - connectorImplementstionId: - type: string - description: The connector implementstion id - example: delimited-file - SourceHealthDto: - type: object - description: Dto for source health data - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - type: - type: string - description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc..' - example: OpenLDAP - Direct - name: - type: string - description: the name of the source - example: Source1234 - org: - type: string - description: source's org - example: denali-cjh - isAuthoritative: - type: boolean - isCluster: - type: boolean - hostname: - type: string - example: megapod-useast1-secret-hostname.sailpoint.com - pod: - type: string - description: source's pod - example: megapod-useast1 - iqServiceVersion: - type: string - example: iqVersion123 - status: - type: string - enum: - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - description: connection test result - example: SOURCE_STATE_UNCHECKED_SOURCE - Transform: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - id: - type: string - readOnly: true - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - example: dateFormat - externalDocs: - description: Transform Operations - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations' - attributes: - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: 'The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.' - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - accountSortDescending: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)' - example: false - accountReturnFirstLink: - type: string - description: 'The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false' - example: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - - Only certain searchable attributes are available:
- `nativeIdentity` - the Account ID
- `displayName` - the Account Name
- `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: '(groups.containsAll({''Admin''}) || location == ''Austin'')' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: firstDate < secondDate | - | LTE | Less than or equal to: firstDate <= secondDate | - | GT | Strictly greater than: firstDate > secondDate | - | GTE | Greater than or equal to: firstDate >= secondDate | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure' - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Generic rule that needs to be invoked by the transform - example: Generic Calculation Rule - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: 'A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.' - example: admin_ - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: lower - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: 'An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.' - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: 'https://regex101.com/' - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: 'This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data' - example: ',' - index: - type: string - description: 'An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.' - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: static - type: object - required: - - values - properties: - values: - type: string - description: 'This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.' - example: string$variable - externalDocs: - description: Static Transform Documentation - url: 'https://developer.sailpoint.com/idn/docs/transforms/operations/static' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: trim - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: upper - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: 'This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.' - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - internal: - type: boolean - readOnly: true - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - WorkItems: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - type: - type: string - enum: - - UNKNOWN - - GENERIC - - CERTIFICATION - - REMEDIATION - - DELEGATION - - APPROVAL - - VIOLATIONREVIEW - - FORM - - POLICYVIOLATION - - CHALLENGE - - IMPACTANALYSIS - - SIGNOFF - - EVENT - - MANUALACTION - - TEST - remediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - approvalItems: - type: object - properties: - id: - type: string - description: ID of the approval item - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - application: - type: string - description: The name the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute - example: emailAddress - attributeOperation: - type: string - description: The operation of the attribute - example: update - attributeValue: - type: string - description: The value of the attribute - example: a@b.com - state: - type: string - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - name: - type: string - description: The work item name - example: Account Create - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - numItems: - type: integer - description: The number of items in the work item - example: 19 - form: - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the form - example: AccountSelection Form - title: - type: string - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: object - allOf: - - type: object - properties: - name: - type: string - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - WorkItemsCount: - type: object - properties: - count: - type: integer - description: The count of work items - example: 29 - WorkItemsSummary: - type: object - properties: - open: - type: integer - description: The count of open work items - example: 29 - completed: - type: integer - description: The count of completed work items - example: 1 - total: - type: integer - description: The count of total work items - example: 30